# Invoice Manager
Invoice module for [AllianceAuth](https://gitlab.com/allianceauth/allianceauth) with simplicity and extendability in mind.
Included `Bits and Bobs`:
- Simple Invoice Model
- Assigned to Character
- Due Dates
- Invoice Ref used for tracking payments
- Notifications
- Simple task for checking for payments
The `ToDo` List:
- Make Payment Corp selectable at invoice level
- Add the Open info in game from SRP-Mod
## Installation
0. this app is built as a sub module of [corptools](https://github.com/pvyParts/allianceauth-corp-tools), please install this first.
1. Install the app `pip install -U allianceauth-invoices`
2. Add `'invoices',` to your `INSTALLED_APPS` in your projects `local.py`
3. run migrations, collect static and restart auth
- `python manage.py migrate invoices`
- `python manage.py collectstatic`
- `supervisorctrl restart all`
4. go go the following address to set up default cron tasks `AUTH ADDRESS/invoice/admin_create_tasks/`
5. setup your perms as documented below
6. add characters and corp tokens as required
7. Setup update tasks if you wish for the data to be auto updated. See Usage Below.
## Updates
1. Install the app `pip install -U allianceauth-invoices`
2. run migrations, collect static and restart auth
- `python manage.py migrate invoices`
- `python manage.py collectstatic`
- `supervisorctrl restart all`
## Set Corp ID
Add the below lines to your `local.py` settings file, Changing the contexts to yours.
```python
## Settings for Invoice Manager
PAYMENT_CORP = 123456789
```
You can optionally se the name of the app in the ui by setting this setting
```python
## name for Invoice Manager
INVOICES_APP_NAME = "Invoices Pay Now!"
```
## Permissions
There are some basic access perms
Admin perms are filtered by main character, if a person has neutral alts loaded their invoices will also be visible to someone who can see their main.
| Perm | Admin Site | Perm | Description |
| --------------- | ---------- | -------------------------------- | --------------------------------------------------- |
| access_invoices | nill | Can Access the Invoice App. | Generic Access perm to show the Invoice menu option |
| view_all | nill | Can View All Invoices. | Superuser level access |
| view_alliance | nill | Can View Own Alliances Invoices. | Alliance only level access |
| view_corp | nill | Can View Own Corps Invoices. | Corp restricted level access |
## Notification Settings
You can disable the notifications generated by this app for either discord or auth by setting the following to `false` the defaults are `True`
```python
## No Auth Notifications
INVOICES_SEND_AUTH_NOTIFICATIONS = False
## No Discord Notifications
INVOICES_SEND_DISCORD_BOT_NOTIFICATIONS = False
```
Raw data
{
"_id": null,
"home_page": "https://github.com/Solar-Helix-Independent-Transport/allianceauth-invoice-manager",
"name": "allianceauth-invoices",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "AaronKable",
"author_email": "aaronkable@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/6d/54/1b46049710ba52d7f7192bde4273d6763e17abecb34a8d7e7eaf119e5e32/allianceauth-invoices-0.1.5.tar.gz",
"platform": null,
"description": "# Invoice Manager\n\nInvoice module for [AllianceAuth](https://gitlab.com/allianceauth/allianceauth) with simplicity and extendability in mind.\n\nIncluded `Bits and Bobs`:\n\n- Simple Invoice Model\n - Assigned to Character\n - Due Dates\n - Invoice Ref used for tracking payments\n - Notifications\n- Simple task for checking for payments\n\nThe `ToDo` List:\n\n- Make Payment Corp selectable at invoice level\n- Add the Open info in game from SRP-Mod\n\n## Installation\n\n0. this app is built as a sub module of [corptools](https://github.com/pvyParts/allianceauth-corp-tools), please install this first.\n1. Install the app `pip install -U allianceauth-invoices`\n2. Add `'invoices',` to your `INSTALLED_APPS` in your projects `local.py`\n3. run migrations, collect static and restart auth\n - `python manage.py migrate invoices`\n - `python manage.py collectstatic`\n - `supervisorctrl restart all`\n4. go go the following address to set up default cron tasks `AUTH ADDRESS/invoice/admin_create_tasks/`\n5. setup your perms as documented below\n6. add characters and corp tokens as required\n7. Setup update tasks if you wish for the data to be auto updated. See Usage Below.\n\n## Updates\n\n1. Install the app `pip install -U allianceauth-invoices`\n2. run migrations, collect static and restart auth\n - `python manage.py migrate invoices`\n - `python manage.py collectstatic`\n - `supervisorctrl restart all`\n\n## Set Corp ID\n\nAdd the below lines to your `local.py` settings file, Changing the contexts to yours.\n\n```python\n## Settings for Invoice Manager\nPAYMENT_CORP = 123456789\n```\n\nYou can optionally se the name of the app in the ui by setting this setting\n\n```python\n## name for Invoice Manager\nINVOICES_APP_NAME = \"Invoices Pay Now!\"\n```\n\n## Permissions\n\nThere are some basic access perms\n\nAdmin perms are filtered by main character, if a person has neutral alts loaded their invoices will also be visible to someone who can see their main.\n\n| Perm | Admin Site | Perm | Description |\n| --------------- | ---------- | -------------------------------- | --------------------------------------------------- |\n| access_invoices | nill | Can Access the Invoice App. | Generic Access perm to show the Invoice menu option |\n| view_all | nill | Can View All Invoices. | Superuser level access |\n| view_alliance | nill | Can View Own Alliances Invoices. | Alliance only level access |\n| view_corp | nill | Can View Own Corps Invoices. | Corp restricted level access |\n\n## Notification Settings\n\nYou can disable the notifications generated by this app for either discord or auth by setting the following to `false` the defaults are `True`\n\n```python\n## No Auth Notifications\nINVOICES_SEND_AUTH_NOTIFICATIONS = False\n\n\n## No Discord Notifications\nINVOICES_SEND_DISCORD_BOT_NOTIFICATIONS = False\n```\n\n\n",
"bugtrack_url": null,
"license": "GNU General Public License v3 (GPLv3)",
"summary": "Alliance Auth Plugin",
"version": "0.1.5",
"project_urls": {
"Homepage": "https://github.com/Solar-Helix-Independent-Transport/allianceauth-invoice-manager"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6d541b46049710ba52d7f7192bde4273d6763e17abecb34a8d7e7eaf119e5e32",
"md5": "c4df887322cef1d93b206cf7529972be",
"sha256": "96133fafc9c19590a1b608d333f575df937dcb7beda25a620a25b1c27fb023c5"
},
"downloads": -1,
"filename": "allianceauth-invoices-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "c4df887322cef1d93b206cf7529972be",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 650507,
"upload_time": "2024-01-26T03:17:50",
"upload_time_iso_8601": "2024-01-26T03:17:50.004711Z",
"url": "https://files.pythonhosted.org/packages/6d/54/1b46049710ba52d7f7192bde4273d6763e17abecb34a8d7e7eaf119e5e32/allianceauth-invoices-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-26 03:17:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Solar-Helix-Independent-Transport",
"github_project": "allianceauth-invoice-manager",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "allianceauth-invoices"
}
JSON
