Skip to content

[CI] add GH CI #1

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

Merged
merged 1 commit into from
May 23, 2025
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
4 changes: 4 additions & 0 deletions .coveragerc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[run]
omit =
setup.py
start.py
76 changes: 76 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
name: OctoBot-Market-Making-CI
on:
push:
tags:
- '*'
pull_request:

jobs:
lint:
name: ${{ matrix.os }}${{ matrix.arch }} - Python ${{ matrix.version }} - lint
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ ubuntu-latest ]
arch: [ x64 ]
version: [ "3.10.x" ]
steps:
- uses: actions/checkout@v4
- name: Set up Python ${{ matrix.version }}
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.version }}
architecture: ${{ matrix.arch }}

- name: Install dependencies
# note: install octobot from requirements as this CI should only trigger on new OctoBot versions
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

# and therefore its installation should work.
run: pip install -r requirements.txt -r dev_requirements.txt

- name: Pylint
run: |
pylint --rcfile=standard.rc octobot_market_making
if [ $? -ne 1 ]; then exit 0; fi

tests:
name: ${{ matrix.os }}${{ matrix.arch }} - Python - ${{ matrix.python }} - tests
needs: lint
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ ubuntu-latest ]
arch: [ x64 ]
python: [ '3.10' ]

steps:
- uses: actions/checkout@v4
- name: Set up Python ${{ matrix.python }}
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python }}
architecture: ${{ matrix.arch }}

- name: Install dependencies
run: pip install -r requirements.txt -r dev_requirements.txt

- name: Pytests
run: pytest --cov=. --cov-config=.coveragerc --durations=0 -rw tests

publish:
needs: tests
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
uses: Drakkar-Software/.github/.github/workflows/python3_sdist_workflow.yml@master
secrets:
PYPI_OFFICIAL_UPLOAD_URL: ${{ secrets.PYPI_OFFICIAL_UPLOAD_URL }}
PYPI_USERNAME: __token__
PYPI_PASSWORD: ${{ secrets.PYPI_TOKEN }}

notify:
if: ${{ failure() }}
needs:
- lint
- tests
- publish
uses: Drakkar-Software/.github/.github/workflows/failure_notify_workflow.yml@master
secrets:
DISCORD_GITHUB_WEBHOOK: ${{ secrets.DISCORD_GITHUB_WEBHOOK }}
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# OctoBot Market Making

Version [2.0.9](https://github.com/Drakkar-Software/OctoBot-Market-Making/blob/master/CHANGELOG.md)

Your automated market making strategy software to improve your crypto market liquidity.

- On more than 15 supported exchanges
Expand Down Expand Up @@ -78,4 +76,23 @@ OctoBot Market Making comes with a built-in trading simulator which you can use

OctoBot Market Making is the backbone of [OctoBot cloud Market Making](https://market-making.octobot.cloud/?utm_source=github&utm_medium=dk&utm_campaign=regular_open_source_content&utm_content=going_further_1), a self-service market making automation platform.

If you enjoy OctoBot Market Making and wish to automate more complex market making strategies or if you are looking for more capabilities in your market making requirements, [OctoBot cloud Market Making](https://market-making.octobot.cloud/?utm_source=github&utm_medium=dk&utm_campaign=regular_open_source_content&utm_content=going_further_2) might be the right platform for you.
If you enjoy OctoBot Market Making and wish to automate more complex market making strategies or if you are looking for more capabilities in your market making requirements, [OctoBot cloud Market Making](https://market-making.octobot.cloud/?utm_source=github&utm_medium=dk&utm_campaign=regular_open_source_content&utm_content=going_further_2) might be the right platform for you.

## Hardware requirements
- CPU : 1 Core / 1GHz
- RAM : 250 MB
- Disk : 1 GB

## Disclaimer
Do not risk money which you are afraid to lose. USE THE SOFTWARE AT YOUR OWN RISK. THE AUTHORS
AND ALL AFFILIATES ASSUME NO RESPONSIBILITY FOR YOUR TRADING RESULTS.

Always start by running a trading bot in simulation mode and do not engage money
before you understand how it works and what profit/loss you should expect.

Please feel free to read the source code and understand the mechanism of this bot.

## License
GNU General Public License v3.0 or later.

See [GPL-3.0 LICENSE](https://github.com/Drakkar-Software/OctoBot-Market-Making/blob/master/LICENSE) to see the full text.
Loading
Loading