Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[feat] readme. #5

Merged
merged 6 commits into from
Nov 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
3 changes: 3 additions & 0 deletions lyra/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
"""
Init for the lyra client
"""
106 changes: 105 additions & 1 deletion poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "lyra-trading"
version = "0.1.0"
name = "lyra-client"
version = "0.1.1"
description = ""
authors = ["8baller <[email protected]>"]
readme = "README.md"
Expand All @@ -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"]
Expand Down
23 changes: 23 additions & 0 deletions tbump.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
[version]
current = "0.1.1"

# 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"
Loading