diff --git a/README.md b/README.md index 50ceed8..dcc5c53 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ You will need: 1. API Client and Secret -2. Python 3.12 or above +2. Python 3.11 or something sensible or above 3. A method for environment variables like [python-dotenv](https://pypi.org/project/python-dotenv/) ### API client key and secret from the site @@ -37,5 +37,14 @@ API = trustcafeapiwrapper.APIClient( ) profile = API.run_job('userprofile.get', "simon-little") -``` + +from trustcafeapiwrapper.wrappers.post.create_post import create_post + +API.wrapped(create_post( + "This is a test post created via the create_post wrapper function.", +)) +``` +## More +- [Development "Things to think about do"](https://gitlab.com/trustcafe/trustcafe-api-wrapper/-/blob/main/development.md) +- [Documentation](https://gitlab.com/trustcafe/trustcafe-api-wrapper/-/blob/main/documentation.md) diff --git a/documentation.md b/documentation.md new file mode 100644 index 0000000..7e01c84 --- /dev/null +++ b/documentation.md @@ -0,0 +1,18 @@ +# Basic usage (without an .env) +Here's how to make a post to the homepage (aka Maintrunk) + +```python +import trustcafeapiwrapper +from trustcafeapiwrapper.wrappers.post.create_post import create_post + +# Setup the API Client +API = trustcafeapiwrapper.APIClient( + client_id="YOUR_CLIENT_ID" + client_secret="YOUR_CLIENT_SECRET" +) + +# Use the create_post wrapper +API.wrapped(create_post( + "This is a test post created via the create_post wrapper function.", +)) +``` \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index 66adafd..7f2534c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "trustcafeapiwrapper" -version = "0.1.0.1" +version = "0.1.0.3" description = "Add your description here" readme = "README.md" requires-python = ">=3.13" diff --git a/testing.py b/testing.py index a2b1293..bdaa7d6 100644 --- a/testing.py +++ b/testing.py @@ -49,9 +49,9 @@ def save_response(response): -# print("-----------Get a user profile----------------") -# profile = API.run_job('userprofile.get', "simon-little") -# print(profile) +print("-----------Get a user profile----------------") +profile = API.run_job('userprofile.get', "simon-little") +print(profile) # print("-------------- Get a branch -----------------") # branch = API.run_job('branch.get', "music") # print(branch)