Skip to main content

API for the Rogue Scholar science blogging platform.

Project description

Build PyPI version Coverage Maintainability Rating docs GitHub DOI

Rogue Scholar API

The backend server for the Rogue Scholar science blog archive. The Rogue Scholar API is a Python Quart application that provides a RESTful API for the Rogue Scholar service.


Requires Python 3.8 or higher (Python 3.11 recommended). Uses Poetry for dependency management. Depends on credentials for the Rogue Scholar Postgres database (hosted by Supabase) and Rogue Scholar search index (hosted by Typesense):

# required environment variables

The API uses Poetry for dependency management. To install Poetry, see the Poetry documentation. Then install the dependencies and run the server:

poetry install
poetry run quart --app rogue_scholar_api run

The API will then be available at http://localhost:5000.


We use pytest for testing:

poetry run pytest

Follow along via Github Issues. Please open an issue if you encounter a bug or have a feature request.

Note on Patches/Pull Requests

  • Fork the project
  • Write tests for your new feature or a test that reproduces a bug
  • Implement your feature or make a bug fix
  • Do not mess with Rakefile, version or history
  • Commit, push and make a pull request. Bonus points for topical branches.


Documentation (work in progress) for using Rogue Scholar is available at the Rogue Scholar Documentation website.

The Rogue Scholar API documentation is served by default at /openapi.json according to the OpenAPI standard, or at /docs for a SwaggerUI interface, or at /redocs for a redoc interface.


Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

License: MIT

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rogue_scholar_api-0.7.1.tar.gz (18.4 kB view hashes)

Uploaded Source

Built Distribution

rogue_scholar_api-0.7.1-py3-none-any.whl (19.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page