Merge branch 'basic_setup' into develop

Author: coffeepenbit

.bumpversion.cfg

@@ -1,6 +1,28 @@
 [bumpversion]
-current_version = 0.1.0
-commit = True
+current_version = 0.1.0-alpha.2
+commit = False
 tag = False
 
-[bumpversion:file:src/bookstack/__init__.py]
+
+parse =
+    (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)              # major, minor and patch
+    (?:\-(?P<pre>(?:alpha|beta|rc))\.(?P<prenum>\d+))?          # pre-release
+
+serialize =
+    {major}.{minor}.{patch}-{pre}.{prenum}
+    {major}.{minor}.{patch}-{pre}
+    {major}.{minor}.{patch}
+
+[bumpversion:part:pre]
+values =
+    alpha
+    beta
+    rc
+
+[bumpversion:part:prenum]
+first_value = 1
+
+
+[bumpversion:file:src/bookstack/__version__.py]
+
+[bumpversion:file:README.md]

CHANGELOG.md

@@ -2,10 +2,8 @@
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.hmtml)
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.hmtml).
 
 ## [Unreleased]
 
-## [Released]
-### [0.1.0] - YYYY-MM-DD
-Initial release
+## [Released]

README.md

@@ -1,5 +1,29 @@
 # bookstack
+version: 0.1.0-alpha.2
+
 A Python wrapper for [BookStack's](https://www.bookstackapp.com) API
 
-- TODO document examples
+# Installation
+To install `bookstack`, run:
+
+`pip install bookstack`
+
+# Usage
+To use BookStack's API, you'll need to get a token ID and secret.
+
+You can find how to get these values from your BookStack instance's doc page at `http[s]://<example.com>/api/docs`
+
+```python
+import bookstack
+
+# Input the appropriate values for these three variables
+base_url = 'http[s]://<example.com>'
+token_id = '<token_id>'
+token_secret = '<token_secret'>
+
+api = bookstack.BookStack(base_url, token_id=<token_id>, token_secret=<token_secret>)
+```
+
+## TODO
+- Documentation
 - Remove `tests` directory from `.gitignore`

src/bookstack/__init__.py

@@ -1,7 +1 @@
-__author__ = 'coffeepenbit'
-__description__ = "A Python wrapper for BookStack's API"
-__author_email__ = 'coffeepenbit@gmail.com'
-__maintainer__ = 'coffeepenbit'
-__title__ = 'bookstack'
-__url__ = "https://github.com/coffeepenbit/bookstack"
-__version__ = '0.1.0-alpha.2'
+from .models import BookStack

src/bookstack/__version__.py

@@ -0,0 +1,7 @@
+__author__ = 'coffeepenbit'
+__description__ = "A Python wrapper for BookStack's API"
+__author_email__ = 'coffeepenbit@gmail.com'
+__maintainer__ = 'coffeepenbit'
+__title__ = 'bookstack'
+__url__ = "https://github.com/coffeepenbit/bookstack"
+__version__ = '0.1.0-alpha.2'