zev/avt-fresh
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

small docs update

Browse Source
This commit is contained in:
Zev Averbach
2022-04-08 11:55:29 +02:00
parent e65a7c1d23
commit c0e32f7472
2 changed files with 12 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -4,6 +4,13 @@ This is a wrapper of [the roly-poly, not 100% ergonomic Freshbooks web API](http
There are "band-aids" here to work around some of the API's shortcomings. There are "band-aids" here to work around some of the API's shortcomings.
# Install
```
pip install avt-fresh
```
See `Initializing` for additional setup.
# The Goodies # The Goodies
## Invoices ## Invoices
@@ -45,12 +52,6 @@ Once more the `get...` functions return `NamedTuple` instances with some helpful
Then, `update_contacts`, `delete_contact`, `add_contacts`, `get_freshbooks_client_from_client_id`, `get_freshbooks_client_from_email`, and `get_freshbooks_client_from_org_name`. Then, `update_contacts`, `delete_contact`, `add_contacts`, `get_freshbooks_client_from_client_id`, `get_freshbooks_client_from_email`, and `get_freshbooks_client_from_org_name`.
# Install
```
pip install avt-fresh
```
# Prerequisites/Configuration # Prerequisites/Configuration
Make yourself a nice little `.env` file in your home directory or wherever you're going to be calling this library's code. It needs to contain: Make yourself a nice little `.env` file in your home directory or wherever you're going to be calling this library's code. It needs to contain:

9
setup.cfg
View File

@@ -1,6 +1,7 @@
[metadata] [metadata]
description-file=README.md description = A nice, ergonomic wrapper of the Freshbooks API.
license_files=LICENSE.txt description-file = README.md
long_description=file: README.md license_files = LICENSE.txt
long_description_content_type=text/markdown long_description = file: README.md
long_description_content_type = text/markdown