Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jsok/scribbly
Scribbly ERP
https://github.com/jsok/scribbly
Last synced: about 1 month ago
JSON representation
Scribbly ERP
- Host: GitHub
- URL: https://github.com/jsok/scribbly
- Owner: jsok
- Created: 2012-11-22T11:15:31.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2014-05-24T02:03:43.000Z (over 10 years ago)
- Last Synced: 2024-10-16T00:31:45.868Z (3 months ago)
- Language: Python
- Size: 710 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Scribbly ERP
============
Overview
---------
This project is an exercise in:
- Domain Driven Design
- Test Driven Development
- Pythonic packages and modules
- SQLAlchemy and Alembic integration
Installation
------------
Create virtualenv:
```
# virtualenv virtualenv
# source virtualenv/bin/activate
```
Install requirements:
```
# pip install --requirement=requirements.txt
```
Domain
------
### Entities ###
The domain entity groups are:
- Inventory: To track movement of stock
- Sales: Documents which describe purchase orders and invoices containing costs of goods sold
- Products: Details of goods for sale
- Taxons: Hierarchical grouping of products
- Customers: Entities which are able to purchase products and be invoiced
### Services ###
Domain services are:
- Pricing service: Calculate product discounts based on product category and customer discount tier
- Ordering service: Collect orders and acknowledge them
- Delivery service: Aggregate orders from a customer into a delivery
- Invoicing service: Create invoices for deliveries, orders or ad-hoc
### Tests ###
Run tests:
```
# nosetests domain -d -v [--with-coverage --cover-branches --cover-package=domain --cover-html]
```
Infrastructure
--------------
### Persistence ###
Comprised of:
- SQLAlchemy: Database library used to perform all database calls
- alembic: Migrations tool
### Tests ###
Run tests:
```
# nosetests infrastructure -d -v -s
```
Options available:
- `export SQLITE_ECHO=1` for more database engine verbosity
- `export SQLITE_IN_MEMORY=1` to run tests on in-memory sqlite instance