Merge pull request #6 from 8ball030/v0.1.1

V0.1.1

README.md

@@ -0,0 +1,45 @@
+# Lyra V2 Python Client.
+
+This repo provides a unified interface for the Lyra V2 Exchange.
+
+## Dev
+
+### Formatting
+
+```bash
+make fmt
+```
+
+### Linting
+
+```bash
+make lint
+```
+
+### Tests
+
+```bash
+make tests
+```
+
+For convience, all commands can be run with;
+
+```
+make all
+```
+
+### Releases
+### Releasing
+
+We can use `tbump` to automatically bump our versions in preparation of a release.
+
+```bash 
+new_version=0.1.1
+git checkout -b v$new_version
+git push --set-upstream origin $(git rev-parse --abbrev-ref HEAD)
+tbump new_version
+```
+
+The release workflow will then detect that a branch with a `v` prefix exists and create a release from it.
+
+Additionally, the package will be published to PyPI.

lyra/__init__.py

@@ -0,0 +1,3 @@
+"""
+Init for the lyra client
+"""

pyproject.toml

@@ -1,5 +1,5 @@
 [tool.poetry]
-name = "lyra-trading"
+name = "lyra-client"
 version = "0.1.0"
 description = ""
 authors = ["8baller <[email protected]>"]
@@ -25,6 +25,7 @@ pytest = "^7.4.2"
 black = "^23.10.1"
 isort = "^5.12.0"
 flake8 = "^6.1.0"
+tbump = "^6.11.0"
 
 [build-system]
 requires = ["poetry-core"]

tbump.toml

@@ -0,0 +1,23 @@
+[version]
+current = "0.1.0"
+
+# Example of a semver regexp.
+# Make sure this matches current_version before
+# using tbump
+regex = '''
+  (?P<major>\d+)
+  \.
+  (?P<minor>\d+)
+  \.
+  (?P<patch>\d+)
+  '''
+
+[git]
+message_template = "Bump to {new_version}"
+tag_template = "v{new_version}"
+
+# For each file to patch, add a [[file]] config
+# section containing the path of the file, relative to the
+# tbump.toml location.
+[[file]]
+src = "pyproject.toml"