Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (17.9%) to scientific vocabulary
Repository
Python utilities for writing pub quizzes
Basic Info
- Host: GitHub
- Owner: elinscott
- License: mit
- Language: Python
- Default Branch: main
- Size: 5.41 MB
Statistics
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
pubquiz
Python utilities for creating slides and answer booklets for pub quizzes.
Getting Started
Create all of the files required for a pub quiz by putting all your questions in a quiz.yaml file and then running the command
shell
pubquiz make quiz.yaml
Of course, the quiz.yaml contents need to follow a given structure; here is an example:
yaml
title: My First Quiz
author: Firstname Lastname
rounds:
- title: First Round
questions:
- question: "Hello?"
answer: "World!"
- title: Second Round
description: Here I explain how this round works
questions:
- question: "Testing, testing"
answer: "One two, one two"
Command Line Interface
The pubquiz command line tool is automatically installed. It can
be used from the shell with the --help flag to show all subcommands.
Installation
The most recent release can be installed from PyPI with:
shell
pip install pubquiz
The most recent code and data can be installed directly from GitHub with:
shell
pip install git+https://github.com/elinscott/pubquiz.git
Contributing
Contributions, whether filing an issue, making a pull request, or forking, are appreciated. See CONTRIBUTING.md for more information on getting involved.
Attribution
License
The code in this package is licensed under the MIT License.
Cookiecutter
This package was created with @audreyfeldroy's cookiecutter package using @cthoyt's cookiecutter-snekpack template.
For Developers
See developer instructions
The final section of the README is for if you want to get involved by making a code contribution. ### Development Installation To install in development mode, use the following: ```bash git clone git+https://github.com/elinscott/pubquiz.git cd pubquiz pip install -e . ``` ### Testing After cloning the repository and installing `tox` with `pip install tox`, the unit tests in the `tests/` folder can be run reproducibly with: ```shell tox ``` Additionally, these tests are automatically re-run with each commit in a [GitHub Action](https://github.com/elinscott/pubquiz/actions?query=workflow%3ATests). ### Building the Documentation The documentation can be built locally using the following: ```shell git clone git+https://github.com/elinscott/pubquiz.git cd pubquiz tox -e docs open docs/build/html/index.html ``` The documentation automatically installs the package as well as the `docs` extra specified in the [`setup.cfg`](setup.cfg). `sphinx` plugins like `texext` can be added there. Additionally, they need to be added to the `extensions` list in [`docs/source/conf.py`](docs/source/conf.py). The documentation can be deployed to [ReadTheDocs](https://readthedocs.io) using [this guide](https://docs.readthedocs.io/en/stable/intro/import-guide.html). The [`.readthedocs.yml`](.readthedocs.yml) YAML file contains all the configuration you'll need. You can also set up continuous integration on GitHub to check not only that Sphinx can build the documentation in an isolated environment (i.e., with ``tox -e docs-test``) but also that [ReadTheDocs can build it too](https://docs.readthedocs.io/en/stable/pull-requests.html). ### Making a Release After installing the package in development mode and installing `tox` with `pip install tox`, the commands for making a new release are contained within the `finish` environment in `tox.ini`. Run the following from the shell: ```shell tox -e finish ``` This script does the following: 1. Uses [Bump2Version](https://github.com/c4urself/bump2version) to switch the version number in the `setup.cfg`, `src/pubquiz/version.py`, and [`docs/source/conf.py`](docs/source/conf.py) to not have the `-dev` suffix 2. Packages the code in both a tar archive and a wheel using [`build`](https://github.com/pypa/build) 3. Uploads to PyPI using [`twine`](https://github.com/pypa/twine). Be sure to have a `.pypirc` file configured to avoid the need for manual input at this step 4. Push to GitHub. You'll need to make a release going with the commit where the version was bumped. 5. Bump the version to the next patch. If you made big changes and want to bump the version by minor, you can use `tox -e bumpversion -- minor` after.Owner
- Name: Edward Linscott
- Login: elinscott
- Kind: user
- Location: Lausanne, Switzerland
- Company: EPFL
- Website: elinscott.github.io
- Twitter: ed_linscott
- Repositories: 4
- Profile: https://github.com/elinscott
Citation (CITATION.cff)
cff-version: 1.0.2 message: "If you use this software, please cite it as below." title: "pubquiz" authors: - name: "Edward Linscott" version: 0.0.6-dev doi: url: "https://github.com/elinscott/pubquiz"
GitHub Events
Total
Last Year
Packages
- Total packages: 1
-
Total downloads:
- pypi 19 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 5
- Total maintainers: 1
pypi.org: pubquiz
Python utilities for writing pub quizzes
- Homepage: https://github.com/elinscott/pubquiz
- Documentation: https://pubquiz.readthedocs.io
- License: MIT
-
Latest release: 0.0.5
published about 2 years ago
Rankings
Maintainers (1)
Dependencies
- actions/checkout v4 composite
- actions/setup-python v5 composite
- codecov/codecov-action v3 composite