Skip to content

Commit

Permalink
Added more detailed setup instructions about HelpDesk
Browse files Browse the repository at this point in the history
  • Loading branch information
FlorianWilhelm committed Dec 10, 2023
1 parent 21af049 commit fedb652
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 10 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@ Pytanis includes a [Pretalx] client and all the tooling you need for conferences
| Package | [![PyPI - Version](https://img.shields.io/pypi/v/pytanis.svg?logo=pypi&label=PyPI&logoColor=gold)](https://pypi.org/project/pytanis/) [![PyPI - Downloads](https://img.shields.io/pypi/dm/pytanis.svg?color=blue&label=Downloads&logo=pypi&logoColor=gold)](https://pepy.tech/project/pytanis) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pytanis.svg?logo=python&label=Python&logoColor=gold)](https://pypi.org/project/pytanis/) |
| Details | [![Project generated with PyScaffold](https://img.shields.io/badge/-PyScaffold-005CA0?logo=pyscaffold)](https://pyscaffold.org/) [![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch) [![code style - black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![types - Mypy](https://img.shields.io/badge/types-Mypy-blue.svg)](https://github.com/python/mypy) [![imports - isort](https://img.shields.io/badge/imports-isort-ef8336.svg)](https://github.com/pycqa/isort) [![License - MIT](https://img.shields.io/badge/license-MIT-9400d3.svg)](https://spdx.org/licenses/) [![GitHub Sponsors](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=ff69b4)](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!
Expand Down Expand Up @@ -73,7 +70,14 @@ later. Note that `config.toml` references those two files relative to its own lo
- **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.
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 argent</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

Expand Down Expand Up @@ -126,9 +130,10 @@ To start this project off a lot of inspiration and code was taken from [Alexande
[GitHub Pages]: https://docs.github.com/en/pages
[PyConDE]: https://pycon.de/
[EuroPython]: https://europython.eu/
[LiveChat Developer Console]: https://developers.livechat.com/console/apps
[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/
1 change: 1 addition & 0 deletions docs/snippets/links.txt
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,4 @@
[mypy]: https://mypy-lang.org/
[isort]: https://pycqa.github.io/isort/
[pretalx-public-voting]: https://github.com/pretalx/pretalx-public-voting
[Pytanis]: https://github.com/FlorianWilhelm/pytanis
10 changes: 5 additions & 5 deletions notebooks/pyconde-pydata-berlin-2024/10_selection_v1.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -105,12 +105,12 @@
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "b47dcae516f0411fb92af233fb3b105c",
"model_id": "384ea4ce2dd140779a770efbc71c3c6a",
"version_major": 2,
"version_minor": 0
},
"text/plain": [
" 0%| | 0/20 [00:00<?, ?it/s]"
" 0%| | 0/27 [00:00<?, ?it/s]"
]
},
"metadata": {},
Expand All @@ -119,12 +119,12 @@
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "0a1526f4e5464407ade1e171aeb60f7e",
"model_id": "57d73d0e4c244bb1a44d5d69bc3ee5a4",
"version_major": 2,
"version_minor": 0
},
"text/plain": [
" 0%| | 0/15 [00:00<?, ?it/s]"
" 0%| | 0/25 [00:00<?, ?it/s]"
]
},
"metadata": {},
Expand All @@ -133,7 +133,7 @@
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "e0a02540f98b4947b2cec13bee707dc1",
"model_id": "4d92aa9f98774850b0247f431866bc25",
"version_major": 2,
"version_minor": 0
},
Expand Down

0 comments on commit fedb652

Please sign in to comment.