geopardy¶
Features¶
TODO
Usage¶
Please see the Command-line Reference for details.
Credits¶
This package was created with cookietemple using Cookiecutter based on Hypermodern_Python_Cookiecutter.
geopardy¶
Features¶
TODO
Usage¶
Please see the Command-line Reference for details.
Credits¶
This package was created with cookietemple using Cookiecutter based on Hypermodern_Python_Cookiecutter.
Installation¶
Stable release¶
To install geopardy, run this command in your terminal:
$ pip install geopardy
This is the preferred method to install geopardy, as it will always install the most recent stable release.
If you don’t have pip installed, this Python installation guide can guide you through the process.
From sources¶
The sources for geopardy can be downloaded from the Github repo. Please note that you require poetry to be installed.
You can either clone the public repository:
$ git clone git://github.com/Zeitsperre/geopardy
Or download the tarball:
$ curl -OJL https://github.com/Zeitsperre/geopardy/tarball/master
Once you have a copy of the source, you can install it with:
$ make install
Usage¶
Reference¶
Contributor Guide¶
Thank you for your interest in improving this project. This project is open-source under the Affero license and highly welcomes contributions in the form of bug reports, feature requests, and pull requests.
Here is a list of important resources for contributors:
How to report a bug¶
Report bugs on the Issue Tracker.
How to request a feature¶
Request features on the Issue Tracker.
How to set up your development environment¶
You need Python 3.7+ and the following tools:
You can install them with:
$ pip install poetry nox nox-poetry
Install the package with development requirements:
$ make install
You can now run an interactive Python session, or the command-line interface:
$ poetry run python
$ poetry run geopardy
How to test the project¶
Run the full test suite:
$ nox
List the available Nox sessions:
$ nox --list-sessions
You can also run a specific Nox session. For example, invoke the unit test suite like this:
$ nox --session=tests
Unit tests are located in the tests directory,
and are written using the pytest testing framework.
How to submit changes¶
Open a pull request to submit changes to this project against the development branch.
Your pull request needs to meet the following guidelines for acceptance:
The Nox test suite must pass without errors and warnings.
Include unit tests. This project maintains a high code coverage.
If your changes add functionality, update the documentation accordingly.
To run linting and code formatting checks before committing your change, you can install pre-commit as a Git hook by running the following command:
$ nox --session=pre-commit -- install
It is recommended to open an issue before starting work on anything. This will allow a chance to talk it over with the owners and validate your approach.
Credits¶
Development Lead¶
Trevor James Smith <trevor_smith@live.com>
Contributors¶
None yet. Why not be the first?
Contributor Covenant Code of Conduct¶
Our Pledge¶
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
Our Standards¶
Examples of behavior that contributes to creating a positive environment include:
Using welcoming and inclusive language
Being respectful of differing viewpoints and experiences
Gracefully accepting constructive criticism
Focusing on what is best for the community
Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
The use of sexualized language or imagery and unwelcome sexual attention or advances
Trolling, insulting/derogatory comments, and personal or political attacks
Public or private harassment
Publishing others’ private information, such as a physical or electronic address, without explicit permission
Other conduct which could reasonably be considered inappropriate in a professional setting
Our Responsibilities¶
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
Scope¶
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
Enforcement¶
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project’s leadership.
Attribution¶
This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html