Skip to content

Commit eb199f8

Browse files
author
Moderyo
committed
docs: fix API key format, add docs/links section, fix GitHub org case
1 parent 3cebcee commit eb199f8

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

README.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ poetry add moderyo
2424
from moderyo import Moderyo
2525

2626
# Initialize client
27-
client = Moderyo(api_key="sk_live_xxxxx")
27+
client = Moderyo(api_key="mod_your_api_key")
2828

2929
# Moderate content
3030
result = client.moderate("Hello, this is a test message")
@@ -42,7 +42,7 @@ import asyncio
4242
from moderyo import AsyncModeryo
4343

4444
async def main():
45-
client = AsyncModeryo(api_key="sk_live_xxxxx")
45+
client = AsyncModeryo(api_key="mod_your_api_key")
4646

4747
result = await client.moderate("Check this content")
4848
print(result.action)
@@ -68,7 +68,7 @@ for result in results:
6868

6969
```python
7070
client = Moderyo(
71-
api_key="sk_live_xxxxx",
71+
api_key="mod_your_api_key",
7272

7373
# Optional settings
7474
base_url="https://api.moderyo.com", # Custom API endpoint
@@ -93,7 +93,7 @@ from moderyo.exceptions import (
9393
APIError
9494
)
9595

96-
client = Moderyo(api_key="sk_live_xxxxx")
96+
client = Moderyo(api_key="mod_your_api_key")
9797

9898
try:
9999
result = client.moderate("Some content")
@@ -158,7 +158,7 @@ app = FastAPI()
158158
@app.post("/messages")
159159
async def create_message(
160160
content: str,
161-
moderation = Depends(ModeryoDep(api_key="sk_live_xxx"))
161+
moderation = Depends(ModeryoDep(api_key="mod_your_api_key"))
162162
):
163163
result = await moderation.check(content)
164164

@@ -189,7 +189,7 @@ from moderyo.integrations.flask import require_moderation
189189
app = Flask(__name__)
190190

191191
@app.route('/messages', methods=['POST'])
192-
@require_moderation(api_key="sk_live_xxx", field='content')
192+
@require_moderation(api_key="mod_your_api_key", field='content')
193193
def create_message():
194194
return jsonify({'status': 'ok'})
195195
```
@@ -198,7 +198,7 @@ def create_message():
198198

199199
```bash
200200
# Clone repository
201-
git clone https://github.com/moderyo/moderyo-python.git
201+
git clone https://github.com/Moderyo/moderyo-python.git
202202
cd moderyo-python
203203

204204
# Install dependencies
@@ -214,7 +214,14 @@ poetry run mypy moderyo
214214

215215
## Examples
216216

217-
See the [playground-examples](https://github.com/moderyo/playground-examples/tree/main/python) repository for a complete working FastAPI server example.
217+
See the [playground-examples](https://github.com/Moderyo/playground-examples/tree/main/python) repository for a complete working FastAPI server example.
218+
219+
## Links
220+
221+
- **PyPI:** [pypi.org/project/moderyo](https://pypi.org/project/moderyo/)
222+
- **Documentation:** [docs.moderyo.com/sdk/python](https://docs.moderyo.com/sdk/python)
223+
- **GitHub:** [github.com/Moderyo/moderyo-python](https://github.com/Moderyo/moderyo-python)
224+
- **Website:** [moderyo.com](https://moderyo.com)
218225

219226
## License
220227

0 commit comments

Comments
 (0)