README.md

   1 # Coffeebot getter
   2 Somehow friendly API to get and share coffee related data from database.
   3
   4 # Contribute
   5 ## Code
   6 For quick orientation see the [changelog][1].
   7
   8 Please, think about [The seven rules of a great Git commit message][2] when
   9 making commit. The project use [OneFlow][3] branching model with the `master`
  10 branch as the branch where the development happens.
  11
  12 ## TDD
  13 Test Driven Development (TDD) is used in this project. Each *feature* **must**
  14 start with adding test and all the tests **must** pass before merge to the
  15 *master*.
  16
  17 Run the tests by:
  18 ```
  19 python3 -m unittest discover ut/
  20 ```
  21
  22 See [unittest][5] for start.
  23
  24 ## Database
  25 By default, sqlite3 `coffee.db` file is needed. You may create testing copy of
  26 database by:
  27 ```
  28 python3 -c '
  29 from ut.test_db import create_test_db
  30 create_test_db("coffee.db")
  31 '
  32 ```
  33
  34 Database is needed to pass the tests.
  35
  36 ## License
  37 This project is developed under [GNU GPLv3 license][4].
  38
  39 [1]: ./CHANGELOG.md
  40 [2]: https://chris.beams.io/posts/git-commit/
  41 [3]: http://endoflineblog.com/oneflow-a-git-branching-model-and-workflow
  42 [4]: ./LICENSE
  43 [5]: https://docs.python.org/3.5/library/unittest.html