https://github.com/replit/replit-py

A helpful Python package that helps you build excellent things inside Repls! 💻
https://github.com/replit/replit-py

api-wrappers database education key-value-store python-library repl replit

Last synced: 4 days ago
JSON representation

A helpful Python package that helps you build excellent things inside Repls! 💻

• Host: GitHub
• URL: https://github.com/replit/replit-py
• Owner: replit
• License: isc
• Created: 2020-07-27T18:30:21.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-11-20T08:16:07.000Z (about 1 month ago)
• Last Synced: 2024-12-21T02:02:37.844Z (11 days ago)
• Topics: api-wrappers, database, education, key-value-store, python-library, repl, replit
• Language: Python
• Homepage: https://replit-py.readthedocs.io
• Size: 3.84 MB
• Stars: 163
• Watchers: 43
• Forks: 56
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
### `>>> import replit`

[![Run on Repl.it](https://img.shields.io/badge/run-on_Replit-f26208?logo=replit)](https://repl.it/github/replit/replit-py) [![pypi: replit](https://img.shields.io/pypi/v/replit)](https://pypi.org/project/replit/) [![Read the Docs](https://img.shields.io/readthedocs/replit-py/latest?logo=readthedocs&label=ReadTheDocs)](https://replit-py.readthedocs.io/)

This repository is the home for the `replit` Python package, which provides:

- A fully-featured database client for [Replit DB](https://docs.replit.com/category/databases).

- Tools and utilities for Flask Web Development, including an interface to Replit's User Authetication service

- Replit user profile metadata retrieval (more coming here!).

### Open Source License

This library is licensed under the [ISC License](https://en.wikipedia.org/wiki/ISC_license) and is free for you to use, change, or even profit from!

### Setup

With poetry already setup, you can set up the repl for development with:

```

poetry install

```

### Continuous Integration

Running the database unittests `tests/test_database.py` depends on the repl https://replit.com/@util/database-test-jwt. You'll have access to this repl if you are a Replit employee. There's a secret

contained in that repl which you'll have to set as an environment variable in order to run the unittests.

Once you've done that, run the tests with:

```

poetry run python -m unittest

```