# PronounDB Python API
API wrapper for the pronoundb.org API.
## Installation
```bash
pip install pronoundb
```
## Examples
lookup someone's pronouns by their discord id:
```py
from pronoundb import lookup, Platform
lookup(Platform.DISCORD, 123456789012345678)
# -> {123456789012345678: ["he", "him"]}
```
lookup someone's pronouns by their minecraft (java) uuid:
```py
from pronoundb import lookup, Platform
lookup(Platform.MINECRAFT, "12345678-1234-1234-1234-123456789012")
# -> {"12345678-1234-1234-1234-123456789012": ["they", "them"]}
```
lookup multiple users pronouns by their discord id:
```py
from pronoundb import lookup, Platform
lookup(Platform.DISCORD, [123456789012345678, 987654321098765432])
# -> {123456789012345678: ["he", "him"], 987654321098765432: ["she", "her"]}
```
## Supported Platforms
- Discord
- GitHub
- Minecraft (Java)
- Twitch
- Twitter
## Custom Pronouns (Version 2.0.0)
Beginning with version 2.0.0, you can give the lookup function a list of pronouns to translate them, for example.
```py
from pronoundb import lookup, Platform
lookup(Platform.DISCORD, 123456789012345678, {
"unspecified": [],
"he": ["Er", "Ihn"],
"she": ["Sie", "Ihr"],
"it": ["Es", "Seine"],
"they": ["They", "Them"],
"any": ["Jede"],
"other": ["Anderes"],
"ask": ["Frag"],
"avoid": ["Nutz Name"],
})
# -> {123456789012345678: ["Er", "Ihn"]}
```
## Contributing
Contributions to this library are always welcome and highly encouraged.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": "https://git.steffo.dev/SteffoSpieler/python-pronoundb-lib",
"name": "pronoundb",
"maintainer": "SteffoSpieler",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "steffo@steffospieler.de",
"keywords": "pronouns,pronoundb,api",
"author": "SteffoSpieler",
"author_email": "steffo@steffospieler.de",
"download_url": "https://files.pythonhosted.org/packages/f2/5b/3ea6d4ad9ad99b40b986231353cb06826c882e32898653dcdd85e941a6b4/pronoundb-2.0.4.tar.gz",
"platform": null,
"description": "# PronounDB Python API\n\n\n\n\n\nAPI wrapper for the pronoundb.org API.\n\n## Installation\n\n```bash\npip install pronoundb\n```\n\n## Examples\n\nlookup someone's pronouns by their discord id:\n\n```py\nfrom pronoundb import lookup, Platform\n\nlookup(Platform.DISCORD, 123456789012345678)\n# -> {123456789012345678: [\"he\", \"him\"]}\n```\n\nlookup someone's pronouns by their minecraft (java) uuid:\n\n```py\nfrom pronoundb import lookup, Platform\n\nlookup(Platform.MINECRAFT, \"12345678-1234-1234-1234-123456789012\")\n# -> {\"12345678-1234-1234-1234-123456789012\": [\"they\", \"them\"]}\n```\n\nlookup multiple users pronouns by their discord id:\n\n```py\nfrom pronoundb import lookup, Platform\n\nlookup(Platform.DISCORD, [123456789012345678, 987654321098765432])\n# -> {123456789012345678: [\"he\", \"him\"], 987654321098765432: [\"she\", \"her\"]}\n```\n\n## Supported Platforms\n\n- Discord\n- GitHub\n- Minecraft (Java)\n- Twitch\n- Twitter\n\n## Custom Pronouns (Version 2.0.0)\n\nBeginning with version 2.0.0, you can give the lookup function a list of pronouns to translate them, for example.\n\n```py\nfrom pronoundb import lookup, Platform\n\nlookup(Platform.DISCORD, 123456789012345678, {\n \"unspecified\": [],\n \"he\": [\"Er\", \"Ihn\"],\n \"she\": [\"Sie\", \"Ihr\"],\n \"it\": [\"Es\", \"Seine\"],\n \"they\": [\"They\", \"Them\"],\n \"any\": [\"Jede\"],\n \"other\": [\"Anderes\"],\n \"ask\": [\"Frag\"],\n \"avoid\": [\"Nutz Name\"],\n})\n# -> {123456789012345678: [\"Er\", \"Ihn\"]}\n```\n\n## Contributing\n\nContributions to this library are always welcome and highly encouraged.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "API wrapper for the pronoundb.org API.",
"version": "2.0.4",
"project_urls": {
"Homepage": "https://git.steffo.dev/SteffoSpieler/python-pronoundb-lib",
"Repository": "https://git.steffo.dev/SteffoSpieler/python-pronoundb-lib"
},
"split_keywords": [
"pronouns",
"pronoundb",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9043d30b00865e4c9ce4d7efc6ed2e2e880a55333dd1ce7198d8f84fa45c6a16",
"md5": "254f73e9d94f8f1e53322cc5473f01b7",
"sha256": "181ca215999a191925ea95c261ef74d12de2d386527bf9c87b9ccf55aca0f46e"
},
"downloads": -1,
"filename": "pronoundb-2.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "254f73e9d94f8f1e53322cc5473f01b7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 4323,
"upload_time": "2024-01-19T20:38:14",
"upload_time_iso_8601": "2024-01-19T20:38:14.541291Z",
"url": "https://files.pythonhosted.org/packages/90/43/d30b00865e4c9ce4d7efc6ed2e2e880a55333dd1ce7198d8f84fa45c6a16/pronoundb-2.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f25b3ea6d4ad9ad99b40b986231353cb06826c882e32898653dcdd85e941a6b4",
"md5": "e849596a6a0db2d4ba0ab211bb8886c4",
"sha256": "ec3d569df29fa05bd55ff2664fb8dfe090eb324c376e8120b3f962073fa19477"
},
"downloads": -1,
"filename": "pronoundb-2.0.4.tar.gz",
"has_sig": false,
"md5_digest": "e849596a6a0db2d4ba0ab211bb8886c4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 3708,
"upload_time": "2024-01-19T20:38:18",
"upload_time_iso_8601": "2024-01-19T20:38:18.017075Z",
"url": "https://files.pythonhosted.org/packages/f2/5b/3ea6d4ad9ad99b40b986231353cb06826c882e32898653dcdd85e941a6b4/pronoundb-2.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-19 20:38:18",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pronoundb"
}
JSON