rogue-scholar-api
Readme
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
SUPABASE_URL
SUPABASE_ANON_KEY
TYPESENSE_HOST
TYPESENSE_API_KEY
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.
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
FAQs
API for the Rogue Scholar science blogging platform.
We found that rogue-scholar-api demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Application Security
New SEC disclosure rules aim to enforce timely cyber incident reporting, but fear of job loss and inadequate resources lead to significant underreporting.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.