https://github.com/adamcharnock/swiftwind

User-friendly billing for communal households
https://github.com/adamcharnock/swiftwind

accounting django

Last synced: 12 days ago
JSON representation

User-friendly billing for communal households

• Host: GitHub
• URL: https://github.com/adamcharnock/swiftwind
• Owner: adamcharnock
• License: mit
• Created: 2016-09-13T11:59:11.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2022-01-06T22:22:48.000Z (almost 3 years ago)
• Last Synced: 2024-10-11T11:22:23.663Z (28 days ago)
• Topics: accounting, django
• Language: Python
• Size: 652 KB
• Stars: 11
• Watchers: 5
• Forks: 4
• Open Issues: 14
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.txt
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-starred - adamcharnock/swiftwind - User-friendly billing for communal households (django)

README

        
SwiftWind

=========

This readme has been autogenerated

.. image:: https://img.shields.io/pypi/v/swiftwind.svg

    :target: https://badge.fury.io/py/swiftwind

.. image:: https://img.shields.io/pypi/dm/swiftwind.svg

    :target: https://pypi.python.org/pypi/swiftwind

.. image:: https://img.shields.io/github/license/adamcharnock/swiftwind.svg

    :target: https://pypi.python.org/pypi/swiftwind/

.. image:: https://travis-ci.org/adamcharnock/swiftwind.svg?branch=master

    :target: https://travis-ci.org/adamcharnock/swiftwind/

.. image:: https://coveralls.io/repos/github/adamcharnock/swiftwind/badge.svg?branch=master

    :target: https://coveralls.io/github/adamcharnock/swiftwind?branch=master

Requirements

------------

* Django >= 1.8

* Postgres >= 9.5

* Python >=3.4

Installation

------------

You can deploy directly to heroku using the swiftwind-heroku_ repository:

.. image:: https://www.herokucdn.com/deploy/button.svg

    :target: https://heroku.com/deploy?template=https://github.com/adamcharnock/swiftwind-heroku

You can also deploy Swiftwind within you own Django project. Good examples

of this are the `example_project`_ within this directory, and the

separate `swiftwind-heroku`_ project.

Usage

-----

Once installed you will need to run the following ``manage.py`` commands::

    ./manage.py migrate

    ./manage.py createsuperuser

    ./manage.py swiftwind_create_accounts

Docker compose

--------------

Swiftwind can be run using docker-compose. This will also provide the Postgres database server for you::

    docker-compose run app ./manage.py migrate

    docker-compose up

Credits

-------

Developed by `Adam Charnock`_. I'm a freelance developer, so do get in touch if you have a project.

swiftwind is packaged using seed_.

.. _seed: https://github.com/adamcharnock/seed/

.. _swiftwind-heroku: https://github.com/adamcharnock/swiftwind-heroku

.. _example_project: https://github.com/adamcharnock/swiftwind/tree/master/example_project

.. _Adam Charnock: https://adamcharnock.com