| Name | Pytanis JSON |
| Version |
0.7
JSON |
| download |
| home_page | |
| Summary | Utilities for the program organization of conferences using Pretalx |
| upload_time | 2024-01-01 20:08:47 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.10 |
| license | |
| keywords |
cfp
conference
google sheet
gsheet
helpdesk
pretalx
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align="center">
<img src="https://raw.githubusercontent.com/FlorianWilhelm/pytanis/main/docs/assets/images/logo.svg" alt="Pytanis logo" width="500" role="img">
</div>
Pytanis includes a [Pretalx] client and all the tooling you need for conferences using [Pretalx], from handling the initial call for papers to creating the final program.
<br/>
| | |
|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| CI/CD | [](https://github.com/FlorianWilhelm/pytanis/actions/workflows/run-tests.yml) [](https://coveralls.io/r/FlorianWilhelm/pytanis) [](https://github.com/FlorianWilhelm/pytanis/actions/workflows/publish-pkg.yml) [](https://github.com/FlorianWilhelm/pytanis/actions/workflows/build-rel-docs.yml) |
| Package | [](https://pypi.org/project/pytanis/) [](https://pepy.tech/project/pytanis) [](https://pypi.org/project/pytanis/) |
| Details | [](https://github.com/pypa/hatch) [](https://github.com/charliermarsh/ruff) [](https://github.com/python/mypy) [](https://spdx.org/licenses/) [](https://github.com/sponsors/FlorianWilhelm) |
**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]. Romani ite domum!
## Features
- [x] simple configuration management with a config folder in your home directory, just like many other tools do
- [x] easily access [Google Sheets], potentially filled by some [Google Forms], and download sheets as data frames
- [x] easy to use [Pretalx] client that returns proper Python objects thanks to the power of [pydantic]
- [x] simple [HelpDesk] client for batch mails, e.g. to your reviewers
- [x] awesome [documentation] with best practices for the program committee of any community-based conference
- [x] tools to assign proposals to reviewers based on constraints like preferences
- [x] tools to support the final selection process of proposals
- [x] tools to support the creation of the final program schedule
## Getting started
To install Pytanis simple run:
```commandline
pip install pytanis
```
or to install all recommended additional dependencies:
```commandline
pip install 'pytanis[all]'
```
Then create a configuration file and directory in your user's home directory. For Linux/MacOS/Unix use
`~/.pytanis/config.toml` and for Windows `$HOME\.pytanis\config.toml`, where `$HOME` is e.g. `C:\Users\yourusername\`.
Use your favourite editor to open `config.toml` within the `.pytanis` directory and add the following content:
```toml
[Pretalx]
api_token = "932ndsf9uk32nf9sdkn3454532nj32jn"
[Google]
client_secret_json = "client_secret.json"
token_json = "token.json"
service_user_authentication = false
[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. Note that `service_user_authentication` is not required to be set if authentication via a service user is not necessary (see [GSpread using Service Account] for more details).
### Retrieving the Credentials and Tokens
- **Google**:
- For end users: 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. Note that `config.toml` references those two files relative to its own location.
- For any automation project: Follow [GSpread using Service Account] to generate and download the file `client_secret.json`.
Move it to the `~/.pytanis` folder as `client_secret.json`. Also make sure to set `service_user_authentication = true` in your `~/.pytanis/config.toml`.
- **Pretalx**: The API token can be found in the [Pretalx user settings].
- **HelpDesk**: Login to the [LiveChat Developer Console] then go to <kbd>Tools</kbd> » <kbd>Personal Access Tokens</kbd>.
Choose <kbd>Create new token +</kbd>, enter a the name `Pytanis`, select all scopes and confirm. In the following screen
copy the `Account ID`, `Entity ID` and `Token` and paste them into `config.toml`.
In case there is any trouble with livechat, contact a helpdesk admin. Also note that the `Account ID` from your token is
the `Agent ID` needed when you create a ticket. The `Team ID` you get from [HelpDesk] then <kbd>Agents</kbd> »
<kbd>Name of your agent</kbd> and the final part of the URL shown now.
**When setting up your agent the first time**,
you also need to go to [LiveChat] then log in with your Helpdesk team credentials and click <kbd>Request</kbd> to get an invitation.
An admin of [LiveChat] needs to confirm this and add you as role `admin`. Then, check [HelpDesk] to receive the invitation
and accept.
## Development
This section is only relevant if you want to contribute to Pytanis itself. Your help is highly appreciated!
After having cloned this repository:
1. install [hatch] globally, e.g. `pipx install hatch`,
2. install [pre-commit] globally, e.g. `pipx install pre-commit`,
3. \[only once\] run `hatch config set dirs.env.virtual .direnv` to let [VS Code] find your virtual environments.
and then you are already set up to start hacking. Use `hatch run` to do everything you would normally do in a virtual
environment, e.g. `hatch run juptyer lab` to start [JupyterLab] in the default environment, `hatch run cov` for unit tests
and coverage (like [tox]) or `hatch run docs:serve` to build & serve the documentation. For code hygiene, execute `hatch run lint:all`
in order to run [ruff] and [mypy] or `hatch run lint:fix` to automatically fix formatting issues.
Check out the `[tool.hatch.envs]` sections in [pyproject.toml](pyproject.toml) to learn about other commands.
If you really must enter a virtual environment, use `hatch shell` to enter the default environment.
## Documentation
The [documentation] is made with [Material for MkDocs] and is hosted by [GitHub Pages]. Your help to extend the
documentation, especially in the context of using Pytanis for community conferences like [PyConDE], [EuroPython], etc.
is highly appreciated.
## License & Credits
[Pytanis] is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
To start this project off a lot of inspiration and code was taken from [Alexander Hendorf] and [Matthias Hofmann].
[Pytanis]: https://florianwilhelm.info/pytanis/
[Python]: https://www.python.org/
[Pretalx]: https://pretalx.com/
[hatch]: https://hatch.pypa.io/
[pre-commit]: https://pre-commit.com/
[Prytanis]: https://en.wikipedia.org/wiki/Prytaneis
[Prytaneion]: https://en.wikipedia.org/wiki/Prytaneion
[Python Quickstart for the Google API]: https://developers.google.com/sheets/api/quickstart/python
[GSpread using Service Account]: https://docs.gspread.org/en/v5.12.4/oauth2.html#for-bots-using-service-account
[Pretalx user settings]: https://pretalx.com/orga/me
[documentation]: https://florianwilhelm.info/pytanis/
[Alexander Hendorf]: https://github.com/alanderex
[Matthias Hofmann]: https://github.com/mj-hofmann
[Google Forms]: https://www.google.com/forms/about/
[Google Sheets]: https://www.google.com/sheets/about/
[pydantic]: https://docs.pydantic.dev/
[HelpDesk]: https://www.helpdesk.com/
[Material for MkDocs]: https://github.com/squidfunk/mkdocs-material
[GitHub Pages]: https://docs.github.com/en/pages
[PyConDE]: https://pycon.de/
[EuroPython]: https://europython.eu/
[LiveChat Developer Console]: https://platform.text.com/console/
[JupyterLab]: https://jupyter.org/
[tox]: https://tox.wiki/
[mypy]: https://mypy-lang.org/
[ruff]: https://github.com/astral-sh/ruff
[VS Code]: https://code.visualstudio.com/
[LiveChat]: https://www.livechat.com/
Raw data
{
"_id": null,
"home_page": "",
"name": "Pytanis",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "cfp,conference,google sheet,gsheet,helpdesk,pretalx",
"author": "",
"author_email": "Florian Wilhelm <Florian.Wilhelm@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/39/a9/8bde6b46be1e390202b1f3ab724353151c4719d9af54e7f270d2e18b4cd7/pytanis-0.7.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n<img src=\"https://raw.githubusercontent.com/FlorianWilhelm/pytanis/main/docs/assets/images/logo.svg\" alt=\"Pytanis logo\" width=\"500\" role=\"img\">\n</div>\n\nPytanis includes a [Pretalx] client and all the tooling you need for conferences using [Pretalx], from handling the initial call for papers to creating the final program.\n<br/>\n\n| | |\n|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| CI/CD | [](https://github.com/FlorianWilhelm/pytanis/actions/workflows/run-tests.yml) [](https://coveralls.io/r/FlorianWilhelm/pytanis) [](https://github.com/FlorianWilhelm/pytanis/actions/workflows/publish-pkg.yml) [](https://github.com/FlorianWilhelm/pytanis/actions/workflows/build-rel-docs.yml) |\n| Package | [](https://pypi.org/project/pytanis/) [](https://pepy.tech/project/pytanis) [](https://pypi.org/project/pytanis/) |\n| Details | [](https://github.com/pypa/hatch) [](https://github.com/charliermarsh/ruff) [](https://github.com/python/mypy) [](https://spdx.org/licenses/) [](https://github.com/sponsors/FlorianWilhelm) |\n\n**Trivia**: The name *Pytanis* is a reference to [Prytanis] using the typical *py* prefix of [Python] tools. [Prytanis]\nwas the name given to the leading members of the government of a city (polis) in ancient Greece. Offices that used this\ntitle usually had responsibility for presiding over councils of some kind, which met in the [Prytaneion]. Romani ite domum!\n\n## Features\n\n- [x] simple configuration management with a config folder in your home directory, just like many other tools do\n- [x] easily access [Google Sheets], potentially filled by some [Google Forms], and download sheets as data frames\n- [x] easy to use [Pretalx] client that returns proper Python objects thanks to the power of [pydantic]\n- [x] simple [HelpDesk] client for batch mails, e.g. to your reviewers\n- [x] awesome [documentation] with best practices for the program committee of any community-based conference\n- [x] tools to assign proposals to reviewers based on constraints like preferences\n- [x] tools to support the final selection process of proposals\n- [x] tools to support the creation of the final program schedule\n\n## Getting started\n\nTo install Pytanis simple run:\n\n```commandline\npip install pytanis\n```\n\nor to install all recommended additional dependencies:\n\n```commandline\npip install 'pytanis[all]'\n```\n\nThen create a configuration file and directory in your user's home directory. For Linux/MacOS/Unix use\n`~/.pytanis/config.toml` and for Windows `$HOME\\.pytanis\\config.toml`, where `$HOME` is e.g. `C:\\Users\\yourusername\\`.\nUse your favourite editor to open `config.toml` within the `.pytanis` directory and add the following content:\n\n```toml\n[Pretalx]\napi_token = \"932ndsf9uk32nf9sdkn3454532nj32jn\"\n\n[Google]\nclient_secret_json = \"client_secret.json\"\ntoken_json = \"token.json\"\nservice_user_authentication = false\n\n[HelpDesk]\naccount = \"934jcjkdf-39df-9df-93kf-934jfhuuij39fd\"\nentity_id = \"email@host.com\"\ntoken = \"dal:Sx4id934C3Y-X934jldjdfjk\"\n```\n\nwhere you need to replace the dummy values in the sections `[Pretalx]` and `[HelpDesk]` accordingly. Note that `service_user_authentication` is not required to be set if authentication via a service user is not necessary (see [GSpread using Service Account] for more details).\n\n### Retrieving the Credentials and Tokens\n\n- **Google**:\n - For end users: Follow the [Python Quickstart for the Google API] to generate and download the file `client_secret.json`.\nMove it to the `~/.pytanis` folder as `client_secret.json`. The file `token.json` will be automatically generated\nlater. Note that `config.toml` references those two files relative to its own location.\n - For any automation project: Follow [GSpread using Service Account] to generate and download the file `client_secret.json`.\nMove it to the `~/.pytanis` folder as `client_secret.json`. Also make sure to set `service_user_authentication = true` in your `~/.pytanis/config.toml`.\n- **Pretalx**: The API token can be found in the [Pretalx user settings].\n- **HelpDesk**: Login to the [LiveChat Developer Console] then go to <kbd>Tools</kbd> \u00bb <kbd>Personal Access Tokens</kbd>.\n Choose <kbd>Create new token +</kbd>, enter a the name `Pytanis`, select all scopes and confirm. In the following screen\n copy the `Account ID`, `Entity ID` and `Token` and paste them into `config.toml`.\n In case there is any trouble with livechat, contact a helpdesk admin. Also note that the `Account ID` from your token is\n the `Agent ID` needed when you create a ticket. The `Team ID` you get from [HelpDesk] then <kbd>Agents</kbd> \u00bb\n <kbd>Name of your agent</kbd> and the final part of the URL shown now.\n\n **When setting up your agent the first time**,\n you also need to go to [LiveChat] then log in with your Helpdesk team credentials and click <kbd>Request</kbd> to get an invitation.\n An admin of [LiveChat] needs to confirm this and add you as role `admin`. Then, check [HelpDesk] to receive the invitation\n and accept.\n\n## Development\n\nThis section is only relevant if you want to contribute to Pytanis itself. Your help is highly appreciated!\n\nAfter having cloned this repository:\n\n1. install [hatch] globally, e.g. `pipx install hatch`,\n2. install [pre-commit] globally, e.g. `pipx install pre-commit`,\n3. \\[only once\\] run `hatch config set dirs.env.virtual .direnv` to let [VS Code] find your virtual environments.\n\nand then you are already set up to start hacking. Use `hatch run` to do everything you would normally do in a virtual\nenvironment, e.g. `hatch run juptyer lab` to start [JupyterLab] in the default environment, `hatch run cov` for unit tests\nand coverage (like [tox]) or `hatch run docs:serve` to build & serve the documentation. For code hygiene, execute `hatch run lint:all`\nin order to run [ruff] and [mypy] or `hatch run lint:fix` to automatically fix formatting issues.\nCheck out the `[tool.hatch.envs]` sections in [pyproject.toml](pyproject.toml) to learn about other commands.\nIf you really must enter a virtual environment, use `hatch shell` to enter the default environment.\n\n## Documentation\n\nThe [documentation] is made with [Material for MkDocs] and is hosted by [GitHub Pages]. Your help to extend the\ndocumentation, especially in the context of using Pytanis for community conferences like [PyConDE], [EuroPython], etc.\nis highly appreciated.\n\n## License & Credits\n\n[Pytanis] is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.\nTo start this project off a lot of inspiration and code was taken from [Alexander Hendorf] and [Matthias Hofmann].\n\n[Pytanis]: https://florianwilhelm.info/pytanis/\n[Python]: https://www.python.org/\n[Pretalx]: https://pretalx.com/\n[hatch]: https://hatch.pypa.io/\n[pre-commit]: https://pre-commit.com/\n[Prytanis]: https://en.wikipedia.org/wiki/Prytaneis\n[Prytaneion]: https://en.wikipedia.org/wiki/Prytaneion\n[Python Quickstart for the Google API]: https://developers.google.com/sheets/api/quickstart/python\n[GSpread using Service Account]: https://docs.gspread.org/en/v5.12.4/oauth2.html#for-bots-using-service-account\n[Pretalx user settings]: https://pretalx.com/orga/me\n[documentation]: https://florianwilhelm.info/pytanis/\n[Alexander Hendorf]: https://github.com/alanderex\n[Matthias Hofmann]: https://github.com/mj-hofmann\n[Google Forms]: https://www.google.com/forms/about/\n[Google Sheets]: https://www.google.com/sheets/about/\n[pydantic]: https://docs.pydantic.dev/\n[HelpDesk]: https://www.helpdesk.com/\n[Material for MkDocs]: https://github.com/squidfunk/mkdocs-material\n[GitHub Pages]: https://docs.github.com/en/pages\n[PyConDE]: https://pycon.de/\n[EuroPython]: https://europython.eu/\n[LiveChat Developer Console]: https://platform.text.com/console/\n[JupyterLab]: https://jupyter.org/\n[tox]: https://tox.wiki/\n[mypy]: https://mypy-lang.org/\n[ruff]: https://github.com/astral-sh/ruff\n[VS Code]: https://code.visualstudio.com/\n[LiveChat]: https://www.livechat.com/\n",
"bugtrack_url": null,
"license": "",
"summary": "Utilities for the program organization of conferences using Pretalx",
"version": "0.7",
"project_urls": {
"Documentation": "https://florianwilhelm.info/pytanis/",
"Source": "https://github.com/FlorianWilhelm/pytanis",
"Sponsor": "https://github.com/sponsors/FlorianWilhelm",
"Tracker": "https://github.com/FlorianWilhelm/pytanis/issues"
},
"split_keywords": [
"cfp",
"conference",
"google sheet",
"gsheet",
"helpdesk",
"pretalx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "71a8f36df0a256b8a37f9ea42e9fa959736ceef04aa54cb3b2b3a6c10bc55de0",
"md5": "17e55a064d1eff2a32c48fe5f1e1b690",
"sha256": "905d8a0aec2bec2eb9e53d9cd5e8a82b5f4b87ac57155e3e6b4e4f0e4a989063"
},
"downloads": -1,
"filename": "pytanis-0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "17e55a064d1eff2a32c48fe5f1e1b690",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 26608,
"upload_time": "2024-01-01T20:08:45",
"upload_time_iso_8601": "2024-01-01T20:08:45.095873Z",
"url": "https://files.pythonhosted.org/packages/71/a8/f36df0a256b8a37f9ea42e9fa959736ceef04aa54cb3b2b3a6c10bc55de0/pytanis-0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "39a98bde6b46be1e390202b1f3ab724353151c4719d9af54e7f270d2e18b4cd7",
"md5": "f3f123acd46138d5dad7da1f5f0e4d6f",
"sha256": "8f678d52b0fb4586a7690cf5c24d8da46f053371eea902165d6696438a10e1ab"
},
"downloads": -1,
"filename": "pytanis-0.7.tar.gz",
"has_sig": false,
"md5_digest": "f3f123acd46138d5dad7da1f5f0e4d6f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 23335,
"upload_time": "2024-01-01T20:08:47",
"upload_time_iso_8601": "2024-01-01T20:08:47.509829Z",
"url": "https://files.pythonhosted.org/packages/39/a9/8bde6b46be1e390202b1f3ab724353151c4719d9af54e7f270d2e18b4cd7/pytanis-0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-01 20:08:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "FlorianWilhelm",
"github_project": "pytanis",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "pytanis"
}
