# Django Sage Invoice
Django Sage Invoice is a Django application for managing invoices. It provides a robust admin interface to create, view, and manage invoices and their related components like categories, items, and totals.
## Features
- Create and manage invoices with detailed customer information.
- Customize invoices with logos, backgrounds, signatures, and stamps.
- Add custom columns to each invoice for additional information.
- Generate invoice totals automatically, including tax and discount calculations.
- Export invoices as HTML files bundled in a ZIP archive.
- Choose from predefined templates or define your own.
## Installation
### Using `pip` with `virtualenv`
1. **Create a Virtual Environment**:
```bash
python -m venv .venv
```
2. **Activate the Virtual Environment**:
- On Windows:
```bash
.venv\Scripts\activate
```
- On macOS/Linux:
```bash
source .venv/bin/activate
```
3. **Install `django-sage-invoice`**:
```bash
pip install django-sage-invoice
```
### Using `poetry`
1. **Initialize Poetry** (if not already initialized):
```bash
poetry init
```
2. **Install `django-sage-invoice`**:
```bash
poetry add django-sage-invoice
```
3. **Apply Migrations**:
After installation, make sure to run the following commands to create the necessary database tables:
```bash
python manage.py makemigrations
python manage.py migrate
```
## Configuration
### Django Settings
Add `django-sage-invoice` to your `INSTALLED_APPS` in the Django settings and configure the `SAGE_MODEL_PREFIX` and `SAGE_MODEL_TEMPLATE`:
```python
INSTALLED_APPS = [
# other packages
"sage_tools",
"sage_invoice",
]
SAGE_MODEL_PREFIX = "invoice"
SAGE_MODEL_TEMPLATE = "sage_invoice"
```
Raw data
{
"_id": null,
"home_page": "https://github.com/sageteamorg/django-sage-invoice",
"name": "django-sage-invoice",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "django, invoice, sageteam, django-packages",
"author": "Radin Ghahremani",
"author_email": "radin@sageteam.org",
"download_url": "https://files.pythonhosted.org/packages/97/a0/31d435d3db07a7c48eea1427d4fd6ad358ceddc2603a2d8a594d1e2d9d5f/django_sage_invoice-0.1.6.tar.gz",
"platform": null,
"description": "# Django Sage Invoice\n\nDjango Sage Invoice is a Django application for managing invoices. It provides a robust admin interface to create, view, and manage invoices and their related components like categories, items, and totals.\n\n## Features\n\n- Create and manage invoices with detailed customer information.\n- Customize invoices with logos, backgrounds, signatures, and stamps.\n- Add custom columns to each invoice for additional information.\n- Generate invoice totals automatically, including tax and discount calculations.\n- Export invoices as HTML files bundled in a ZIP archive.\n- Choose from predefined templates or define your own.\n\n## Installation\n\n### Using `pip` with `virtualenv`\n\n1. **Create a Virtual Environment**:\n\n ```bash\n python -m venv .venv\n ```\n\n2. **Activate the Virtual Environment**:\n\n - On Windows:\n\n ```bash\n .venv\\Scripts\\activate\n ```\n\n - On macOS/Linux:\n\n ```bash\n source .venv/bin/activate\n ```\n\n3. **Install `django-sage-invoice`**:\n\n ```bash\n pip install django-sage-invoice\n ```\n\n### Using `poetry`\n\n1. **Initialize Poetry** (if not already initialized):\n\n ```bash\n poetry init\n ```\n\n2. **Install `django-sage-invoice`**:\n\n ```bash\n poetry add django-sage-invoice\n ```\n\n3. **Apply Migrations**:\n\n After installation, make sure to run the following commands to create the necessary database tables:\n\n ```bash\n python manage.py makemigrations\n python manage.py migrate\n ```\n\n## Configuration\n\n### Django Settings\n\nAdd `django-sage-invoice` to your `INSTALLED_APPS` in the Django settings and configure the `SAGE_MODEL_PREFIX` and `SAGE_MODEL_TEMPLATE`:\n\n```python\nINSTALLED_APPS = [\n # other packages\n \"sage_tools\",\n \"sage_invoice\",\n]\nSAGE_MODEL_PREFIX = \"invoice\"\nSAGE_MODEL_TEMPLATE = \"sage_invoice\"\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A project for invoice generation and NFC integration.",
"version": "0.1.6",
"project_urls": {
"Documentation": "https://django-sage-invoice.readthedocs.io/en/latest/",
"Homepage": "https://github.com/sageteamorg/django-sage-invoice",
"Issues": "https://github.com/sageteamorg/django-sage-invoice/issues",
"Repository": "https://github.com/sageteamorg/django-sage-invoice",
"Source Code": "https://github.com/sageteamorg/django-sage-invoice"
},
"split_keywords": [
"django",
" invoice",
" sageteam",
" django-packages"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0b332a1d6b742958d42e18b0c6fdd522253680aea3958f70724449662d4fc5c2",
"md5": "d87c999e3e197b0a0471aa825a756418",
"sha256": "d140e84ab829ac56a8648d2b6c34b34932fafd11122105b2a2a964de49bd1dae"
},
"downloads": -1,
"filename": "django_sage_invoice-0.1.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d87c999e3e197b0a0471aa825a756418",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 335550,
"upload_time": "2024-10-17T17:57:46",
"upload_time_iso_8601": "2024-10-17T17:57:46.664810Z",
"url": "https://files.pythonhosted.org/packages/0b/33/2a1d6b742958d42e18b0c6fdd522253680aea3958f70724449662d4fc5c2/django_sage_invoice-0.1.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "97a031d435d3db07a7c48eea1427d4fd6ad358ceddc2603a2d8a594d1e2d9d5f",
"md5": "95bed54124cc877fcccf6e8a5d30a868",
"sha256": "5322e5e448ba64f211767fd2fcfe2cbd2a93ad4c4f4d45893ceb34cef9dc90b5"
},
"downloads": -1,
"filename": "django_sage_invoice-0.1.6.tar.gz",
"has_sig": false,
"md5_digest": "95bed54124cc877fcccf6e8a5d30a868",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 295604,
"upload_time": "2024-10-17T17:57:49",
"upload_time_iso_8601": "2024-10-17T17:57:49.504621Z",
"url": "https://files.pythonhosted.org/packages/97/a0/31d435d3db07a7c48eea1427d4fd6ad358ceddc2603a2d8a594d1e2d9d5f/django_sage_invoice-0.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-17 17:57:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sageteamorg",
"github_project": "django-sage-invoice",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "django-sage-invoice"
}
JSON
