Skip to main content

Utilities for the program organization of conferences using Pretalx

Project description

Pytanis

Pytanis logo

Pytanis provides useful tools for conferences using Pretalx to handle the call for papers and creating a program!

CI/CD CI - Test Coverage CD - Build Docs - Build
Package PyPI - Version PyPI - Downloads PyPI - Python Version
Details Project generated with PyScaffold Hatch project code style - black types - Mypy imports - isort License - MIT GitHub Sponsors

Trivia: The name Pytanis is a reference to Prytanis using the typical py prefix of Python tools. Prytanis was the name given to the leading members of the government of a city (polis) in ancient Greece. Offices that used this title usually had responsibility for presiding over councils of some kind, which met in the Prytaneion.

This is a pre-alpha version! Don't use it!

Getting started

To install Pytanis simple run:

pip install pytanis

and then create a file ~/.pytanis/config.toml with the content:

[Pretalx]
api_token = "932ndsf9uk32nf9sdkn3454532nj32jn"

[Google]
client_secret_json = "client_secret.json"
token_json = "token.json"

[HelpDesk]
account = "934jcjkdf-39df-9df-93kf-934jfhuuij39fd"
entity_id = "email@host.com"
token = "dal:Sx4id934C3Y-X934jldjdfjk"

where you need to replace the dummy values in the sections [Pretalx] and [HelpDesk] accordingly.

Retrieving the credentials and token

  • Google: Follow the Python Quickstart for the Google API to generate and download the file client_secret.json. Move it to the ~/.pytanis folder as client_secret.json. The file token.json will be automatically generated later.
  • Pretalx: The API token for the Pretalx API can be found in your user settings.
  • HelpDesk: Use the same (shared) email you use to log into helpdesk/livechat to create the token following this video. In case there is any trouble with livechat, contact a helpdesk admin.

Features

  • (planned) creating the assignment of proposals to reviewers based on their preferences
  • (planned) sending e-mails to reviewers
  • (planned) supporting the selection process of proposals
  • (planned) supporting the creation of the final program schedule based on the accepted talks

Development

After having cloned this repository:

  1. install hatch globally, e.g. pipx install hatch,
  2. create the default environment with hatch env create,
  3. activate the default environment with hatch shell,
  4. [only once] run pre-commit install to install pre-commit,

and then you are already set up to start hacking. Use hatch run test:cov or hatch run test:no-cov to run the unitest with or without coverage reports, respectively.

Documentation

The documentation is made with Material for MkDocs and is hosted by GitHub Pages.

License

Pytanis is distributed under the terms of the MIT license.

Credits

To start this project off a lot of inspiration and code was taken from Alexander Hendorf and Matthias Hofmann.

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

pytanis-0.0.1.tar.gz (16.2 kB view hashes)

Uploaded Source

Built Distribution

pytanis-0.0.1-py3-none-any.whl (9.0 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