Skip to content

Commit

Permalink
Make sure docs are current
Browse files Browse the repository at this point in the history
  • Loading branch information
anfederico committed Jun 10, 2021
1 parent e0677f3 commit 9fd7e3d
Show file tree
Hide file tree
Showing 3 changed files with 196 additions and 15 deletions.
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.html linguist-vendored
187 changes: 187 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,187 @@
# General
.DS_Store
.AppleDouble
.LSOverride

# Icon must end with two \r
Icon

# Thumbnails
._*

# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent

# Directories potentially created on remote AFP share
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk

# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
pip-wheel-metadata/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
.hypothesis/
.pytest_cache/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
.python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don’t work, or not
# install all needed dependencies.
#Pipfile.lock

# celery beat schedule file
celerybeat-schedule

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# History files
.Rhistory
.Rapp.history

# Session Data files
.RData

# User-specific files
.Ruserdata

# Example code in package build process
*-Ex.R

# Output files from R CMD build
/*.tar.gz

# Output files from R CMD check
/*.Rcheck/

# RStudio files
.Rproj.user/

# produced vignettes
vignettes/*.html
vignettes/*.pdf

# OAuth2 token, see https://github.com/hadley/httr/releases/tag/v0.3
.httr-oauth

# knitr and R markdown default cache directories
/*_cache/
/cache/

# Temporary files created by R markdown
*.utf8.md
*.knit.md
23 changes: 8 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
<p align="center"><img src="https://github.com/anfederico/Gemini/blob/master/media/logo.png" width="150px"><p>
<p align="center"><img src="https://raw.githubusercontent.com/anfederico/gemini/master/gemini/media/logo.png" width="150px"><p>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
![Python](https://img.shields.io/badge/python-v3.6-blue.svg)
[![Build Status](https://travis-ci.org/anfederico/Gemini.svg?branch=master)](https://travis-ci.org/anfederico/Gemini)
[![Build Status](https://travis-ci.org/anfederico/gemeni.svg?branch=master)](https://travis-ci.org/anfederico/gemeni)
![Dependencies](https://img.shields.io/badge/dependencies-up%20to%20date-brightgreen.svg)
[![GitHub Issues](https://img.shields.io/github/issues/anfederico/Gemini.svg)](https://github.com/anfederico/Gemini/issues)
[![GitHub Issues](https://img.shields.io/github/issues/anfederico/gemeni.svg)](https://github.com/anfederico/gemeni/issues)
![Contributions welcome](https://img.shields.io/badge/contributions-welcome-orange.svg)
[![License](https://img.shields.io/badge/license-GPL-blue.svg)](https://www.gnu.org/licenses/gpl-3.0.en.html)
<br>
<p align="center"><img src="https://github.com/anfederico/Gemini/blob/master/media/schematic.gif" width="550px"><p>
<p align="center"><img src="https://raw.githubusercontent.com/anfederico/gemini/master/gemini/media/schematic.gif" width="550px"><p>

## Install

```bash
pip3 install git+git://github.com/liamhartley/Gemini.git
pip3 install git+git://github.com/anfederico/gemini.git
```

## Load
Expand All @@ -23,8 +23,8 @@ from gemini_core import data, engine, helpers
```

## Examples
- [Automated cryptocurrency trading bot deployed into AWS with Terraform and Python.](https://github.com/liamhartley/crypto_trading_bot)
- [Mean reversion strategy](https://github.com/anfederico/Gemini/blob/master/examples/mean_reversion.ipynb)
- [Basic mean reversion strategy](https://github.com/anfederico/gemeni/blob/master/examples/mean_reversion.ipynb)
- [Automated cryptocurrency trading bot deployed into AWS with Terraform](https://github.com/liamhartley/cryptotradingbot)
- For more information, please refer to the [full documentation](https://gemini-docs.readthedocs.io/en/latest/)*.

#### Input Data (Optional)
Expand Down Expand Up @@ -146,11 +146,4 @@ You can visualize the performance of your strategy by comparing the equity curve
backtest.chart()
```

<p align="center"><img src="https://raw.githubusercontent.com/anfederico/Gemini/master/media/example.png"><p>

#### Acknowledgements

- https://github.com/anfederico/Gemini
- https://github.com/quantroom-pro/cryptocurrency.backtester
- Any other relevant forked project.

<p align="center"><img src="https://raw.githubusercontent.com/anfederico/gemini/master/gemini/media/example.png"><p>

0 comments on commit 9fd7e3d

Please sign in to comment.