crimsontome/SimplyPluralUtils
1
0
Fork 0
mirror of https://github.com/CrimsonTome/SimplyPluralUtils.git synced 2025-05-20 02:50:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
42 commits 3 branches 0 tags 90 KiB
Find a file
Exact
crimsontome 460da75081
🐛 Check for pronouns key in content dictionary before checking its value
2025-04-16 16:14:04 +01:00
src 🐛 Check for pronouns key in content dictionary before checking its value 2025-04-16 16:14:04 +01:00
.gitignore 🐛 Fix importing modules 2025-04-01 14:08:59 +01:00
.python-version 🎉 Begin refactoring from simply-present 2025-03-10 17:02:09 +00:00
LICENSE 📄 Actually add the license 2025-03-15 17:23:10 +00:00
pyproject.toml 🎉 Begin refactoring from simply-present 2025-03-10 17:02:09 +00:00
README.md 📝 Add readme and license 2025-03-15 16:47:58 +00:00
token.example.json 🚚 Move out of subfolder 2025-03-10 21:11:03 +00:00
uv.lock 🎉 Begin refactoring from simply-present 2025-03-10 17:02:09 +00:00

README.md

SimplyPluralUtils

Utilities for working with the Simply Plural API with Python

System requirements

  • Python 3.8 or higher is required to run the tools (tested with 3.13). You can check your Python version by running python --version in your terminal. You can install it using your package manager or from the Python website.
  • Both Windows 10 and Linux have been tested.
    • MacOS should work as well but has not been tested.
  • It is recommended to use uv

Getting started

Clone the repository and navigate to the project directory.

git clone https://git.crimsontome.com/crimsontome/SimplyPluralUtils.git
cd SimplyPluralUtils

In order to get data from Simply Plural you will need to rename the secrets.example.json file to secrets.json and add your Simply Plural API key. You can find your API key by going into settings -> Account -> Tokens -> Add Token. Give it read access and copy the token into the file.

{
    "SimplyPluralAPIKey": "your_api_key_here"
}

Run `uv sync` to install the dependencies and `uv run utils.py` to run the code.

## License

SimplyPluralUtils is licensed under the MIT license. The full license text is included in the [LICENSE](LICENSE) file in this repository. Tldr legal have a [great summary](https://www.tldrlegal.com/license/mit-license) of the license if you're interested.