https://github.com/ppfeufer/aa-esi-status
https://github.com/ppfeufer/aa-esi-status
allianceauth django esi-status python
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/ppfeufer/aa-esi-status
- Owner: ppfeufer
- License: gpl-3.0
- Created: 2020-10-11T10:26:51.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-16T15:29:30.000Z (about 1 year ago)
- Last Synced: 2024-05-17T03:59:17.330Z (about 1 year ago)
- Topics: allianceauth, django, esi-status, python
- Language: Python
- Homepage:
- Size: 961 KB
- Stars: 1
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
[](https://pypi.org/project/aa-esi-status/)
[](https://github.com/ppfeufer/aa-esi-status/blob/master/LICENSE)
[](https://pypi.org/project/aa-esi-status/)
[](https://pypi.org/project/aa-esi-status/)
[](https://results.pre-commit.ci/latest/github/ppfeufer/aa-esi-status/main)
[](http://black.readthedocs.io/en/latest/)
[](https://discord.gg/zmh52wnfvM)
[](https://github.com/ppfeufer/aa-esi-status/actions/workflows/automated-checks.yml)
[](https://codecov.io/gh/ppfeufer/aa-esi-status)
[](https://weblate.ppfeufer.de/engage/alliance-auth-apps/)
[](https://github.com/ppfeufer/aa-esi-status/blob/master/CODE_OF_CONDUCT.md)
[](https://ko-fi.com/N4N8CL1BY)
App for Alliance Auth to show the current status of ESI and its end points.
______________________________________________________________________
- [AA ESI Status](#aa-esi-status)
- [Screenshots](#screenshots)
- [ESI Status Page](#esi-status-page)
- [Dashboard Widget](#dashboard-widget)
- [Installation](#installation)
- [Step 1: Install the App](#step-1-install-the-app)
- [Step 2: Update Your AA Settings](#step-2-update-your-aa-settings)
- [Step 3: Finalizing the Installation](#step-3-finalizing-the-installation)
- [(Optional) Public Views](#optional-public-views)
- [Updating](#updating)
- [Changelog](#changelog)
- [Translation Status](#translation-status)
- [Contributing](#contributing)
______________________________________________________________________
This is how the dashboard widget looks like.
It shows the current status of ESI for administrative users.
> \[!NOTE\]
>
> **AA ESI Status >= 2.0.0 needs at least Alliance Auth v4!**
>
> Please make sure to update your Alliance Auth instance _before_ you install this
> module or update to the latest version, otherwise an update to Alliance Auth will
> be pulled in unsupervised.
>
> The last version of AA ESI Status that supports Alliance Auth v3 is `1.14.2`.
This app is a plugin for Alliance Auth. If you don't have Alliance Auth running
already, please install it first before proceeding.
(See the official [AA installation guide](https://allianceauth.readthedocs.io/en/latest/installation/allianceauth.html) for details)
Make sure you're in the virtual environment (venv) of your Alliance Auth installation.
Then install the latest version:
```shell
pip install aa-esi-status
```
### Step 2: Update Your AA Settings
Configure your AA settings (`local.py`) as follows:
- Add `"esistatus",` to `INSTALLED_APPS`
### Step 3: Finalizing the Installation
Run migrations & copy static files.
```shell
python manage.py collectstatic
python manage.py migrate
```
Restart your supervisor services for AA.
This app supports AA's feature of public views, since the ESI status is not any
mission-critical information.
To allow users to view the time zone conversion page without the need to log in,
please add `"esistatus",` to the list of `APPS_WITH_PUBLIC_VIEWS` in your `local.py`:
```python
# By default, apps are prevented from having public views for security reasons.
# To allow specific apps to have public views, add them to APPS_WITH_PUBLIC_VIEWS
# » The format is the same as in INSTALLED_APPS
# » The app developer must also explicitly allow public views for their app
APPS_WITH_PUBLIC_VIEWS = [
"esistatus", # https://github.com/ppfeufer/aa-esi-status/
]
```
> **Note**
>
> If you don't have a list for `APPS_WITH_PUBLIC_VIEWS` yet, then add the whole
> block from here. This feature has been added in Alliance Auth v3.6.0 so you
> might not yet have this list in your `local.py`.
To update your existing installation of AA ESI Status, first enable your virtual
environment.
Then run the following commands from your AA project directory (the one that
contains `manage.py`).
```shell
pip install -U aa-esi-status
python manage.py collectstatic
python manage.py migrate
```
Now restart your AA supervisor services.
See [CHANGELOG.md](https://github.com/ppfeufer/aa-esi-status/blob/main/CHANGELOG.md)
[](https://weblate.ppfeufer.de/engage/alliance-auth-apps/)
Do you want to help translate this app into your language or improve the existing
translation? - [Join our team of translators][weblate engage]!
Do you want to contribute to this project? That's cool!
Please make sure to read the [Contribution Guidelines](https://github.com/ppfeufer/aa-esi-status/blob/main/CONTRIBUTING.md).\
(I promise, it's not much, just some basics)
[weblate engage]: https://weblate.ppfeufer.de/engage/alliance-auth-apps/ "Weblate Translations"