shiny-invoice


Nameshiny-invoice JSON
Version 0.2.0 PyPI version JSON
download
home_pageNone
SummarySimply manage invoices
upload_time2024-07-29 16:34:33
maintainerNone
docs_urlNone
authorNone
requires_python>=3.12
licenseMIT License Copyright (c) 2024 dtrai2 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords invoice finance accounting
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # Shiny Invoice

This tool is meant as a simple and naive way to manage invoices locally.
It is not meant to be published online and used as an enterprise tool.


## Run

To run `shiny-invoice` you need install it with:

```bash
pip install shiny-invoice
```

Once `shiny-invoice` is installed you need to create configuration file.
A suitable default configuration can be generated with
```bash
shiny-invoice generate-default-config
```

Once everything is set up you can run `shiny-invoice` with:

```bash
shiny-invoice run --config default_config.yaml
```

More information you can find with

```bash
shiny-invoice --help
shiny-invoice run --help
```

## Workflow

This application manages the invoices as plain html files, named by the invoice id.
To turn the html file into a pdf just use the browsers print functionality.
All the data corresponding to the invoices is stored inside a json file, which is configured with the key
`paths.datastore`.
The json you can edit as you like, via the gui it is only possible to change the 'Paid At' value.
This value is also used to determine if in invoice is indeed 'Paid' or 'Unpaid'.

## Impressions

### View of creating a new invoice
![new-invoice.png](docs/new-invoice.png)

### View of existing invoices
![existing-invoices.png](docs/existing-invoices.png)

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "shiny-invoice",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.12",
    "maintainer_email": null,
    "keywords": "invoice, finance, accounting",
    "author": null,
    "author_email": null,
    "download_url": null,
    "platform": null,
    "description": "# Shiny Invoice\n\nThis tool is meant as a simple and naive way to manage invoices locally.\nIt is not meant to be published online and used as an enterprise tool.\n\n\n## Run\n\nTo run `shiny-invoice` you need install it with:\n\n```bash\npip install shiny-invoice\n```\n\nOnce `shiny-invoice` is installed you need to create configuration file.\nA suitable default configuration can be generated with\n```bash\nshiny-invoice generate-default-config\n```\n\nOnce everything is set up you can run `shiny-invoice` with:\n\n```bash\nshiny-invoice run --config default_config.yaml\n```\n\nMore information you can find with\n\n```bash\nshiny-invoice --help\nshiny-invoice run --help\n```\n\n## Workflow\n\nThis application manages the invoices as plain html files, named by the invoice id.\nTo turn the html file into a pdf just use the browsers print functionality.\nAll the data corresponding to the invoices is stored inside a json file, which is configured with the key\n`paths.datastore`.\nThe json you can edit as you like, via the gui it is only possible to change the 'Paid At' value.\nThis value is also used to determine if in invoice is indeed 'Paid' or 'Unpaid'.\n\n## Impressions\n\n### View of creating a new invoice\n![new-invoice.png](docs/new-invoice.png)\n\n### View of existing invoices\n![existing-invoices.png](docs/existing-invoices.png)\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2024 dtrai2  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "Simply manage invoices",
    "version": "0.2.0",
    "project_urls": null,
    "split_keywords": [
        "invoice",
        " finance",
        " accounting"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a3221ca36f01b45e42fe83c360e93c44d4dc72f8859c258e6f9f0374906008d2",
                "md5": "8be5a182486144d5ee414a3731e6171b",
                "sha256": "03ba3233e7fb949c78e166035061161691bad64739da2ef158be0adc458c85c9"
            },
            "downloads": -1,
            "filename": "shiny_invoice-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8be5a182486144d5ee414a3731e6171b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.12",
            "size": 13632,
            "upload_time": "2024-07-29T16:34:33",
            "upload_time_iso_8601": "2024-07-29T16:34:33.196712Z",
            "url": "https://files.pythonhosted.org/packages/a3/22/1ca36f01b45e42fe83c360e93c44d4dc72f8859c258e6f9f0374906008d2/shiny_invoice-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-29 16:34:33",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "shiny-invoice"
}
None
Elapsed time: 0.33413s