Code Monkey home page Code Monkey logo

scribbly's Introduction

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

scribbly's People

Contributors

jsok avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.