Tools for interacting with Toolname, including a Python API wrapper
NOTE: For Python tool repo names, stick with underscores (eg 'tools_app'). Hyphens can cause issues during imports.
One paragraph of project description goes here
- Python 3
- packages listed in the requirements.txt file
There is no formal installation process at this time, but using git subtrees is strongly recommended. Unfortunately there is no 'helper' integration for git subtrees in VS Code, so using the actual git commands are necessary:
git subtree add --prefix tools/Toolname https://github.com/authorname/tools_Toolname master --squash
git fetch https://github.com/authorname/tools_Toolname master
# Breaking the above down, the following command creates the subtree and the connection to the remote repo
'''
git subtree add --prefix <dest-path> <source-repo> <branch> --squash
--prefix <path> specify the destination folder (relative to current working directory).
<source-repo> the repository that is being pulled from
<branch> branch to be pulled (usually 'master', may be 'main' if more recently created in GitHub)
--squash optional but recommended command to discard the commit history of the source repo
'''
#The following command fetches the content of that repo so it will be available for use
'''
git fetch <source-repo> <branch>
<source-repo> the repository that is being pulled from
<branch> branch to be pulled (usually 'master', may be 'main' if more recently created in GitHub)
'''But what if the remote tool repo gets updated? Pulling the latest changes is super easy, barely an inconvenience: just use the same command above with 'git subtree pull' instead of 'git subtree add':
git subtree pull --prefix tools/Toolname https://github.com/epopisces/tools_Toolname master --squash
Alternately git submodules can also be used; however, git submodules are not as easy to maintain and keep updated. The recommendation is only to use git submodules if the tools repo is also going to be developed as part of the project, instead of just used as a static library by the main project.
The differences between git subtrees and git submodules are described in depth in this article.
- Authentication against API
- can do thing 1
- can do thing 2
The below assumes you are using the repo as a subtree as described above. Note this will require creating a empty __init__.py file in the 'tools' folder if there is not one present already so Python's import function can traverse the directories to get to the tool.
import os
from tools.toolname import toolname_api as shortname
acct_email = os.getenv('toolname_email') # Use environment variable by this name to store a username for the API user
acct_pass = os.getenv('toolname_pass') # Use environment variable by this name to store a password for the API user
bb = shortname.ObjectClass(acct_email, acct_pass)
abbrev.{function-name}({parameters})-
Required Arguments
Variable Name Type Required? Description thing1 dict Required Dictionary containing things -
Optional Argument
Variable Name Type Required? Default Description thing2 bool Optional False Determines if a thing happens
Explain how to run the automated tests
- 0.1.0
- The first proper release, signified by upload to FL Github
- 0.0.1
- Work in progress, local dev
- authorname - Created the toolname_api
See also the list of contributors who participated in this project.
This project is licensed under an MIT standard license - see the LICENSE.md file for details
- epopisces created the project template and boilerplate code used for this project
- I owe a lot to my understanding of API wrappers to