Repository files navigation

RethinkDB is the first open-source scalable database built for realtime applications.It exposes a new database access model -- instead of polling for changes, the developercan tell the database to continuously push updated query results to applications in realtime.RethinkDB allows developers to build scalable realtime apps in a fraction of the time withless effort.

RethinkDB Python Client prodvices a set of utility scripts to help you manage your RethinkDBdatabase.

• rethinkdb dump / rethinkdb-dump - Dump a database to a file
• rethinkdb export / rethinkdb-export - Export a table to a file
• rethinkdb import / rethinkdb-import - Import a table from a file
• rethinkdb index-rebuild / rethinkdb-index-rebuild - Rebuild all indexes
• rethinkdb repl / rethinkdb-repl - Start a REPL session
• rethinkdb restore / rethinkdb-restore - Restore a database from a file

RethinkDB's Python Client can be installed by runningpip install rethinkdb and it requiresPython 3.10+ to run. This is the preferred method to install RethinkDB Python client, as it willalways install the most recent stable release. If you don't havepip installed, thisPython installation guide can guide you through the process.

RethinkDB's Python Client tries to be as tiny as its possible, hence some functionalitiesare requiring extra dependencies to be installed.

To install rethinkdb with an extra package runpip install rethinkdb[<EXTRA>],where<EXTRA> is the name of the extra option. To install multiple extra packageslist the extra names separated by comma as described inpip's examples section pointnumber six.

TODO

Hurray, You reached this section, which means you are readyto contribute.

Please read our contibutingguideline. This guideline willwalk you through how can you successfully contribute toRethinkDB Python client.

For development you will needpoetry,pre-commit andshellcheck. After poetry installed,simply run poetry install -E all. This command will both create the virtualenvand install all development dependencies for you.