https://github.com/fearless-spider/spideroptic-cli

cement cli cli-app command-line makefile numpy oanda pypi python

Last synced: 3 months ago
JSON representation

Spider Optic CLI is a command line application.

Host: GitHub
URL: https://github.com/fearless-spider/spideroptic-cli
Owner: fearless-spider
License: bsd-3-clause
Created: 2020-08-16T22:13:29.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2020-08-23T17:02:43.000Z (almost 5 years ago)
Last Synced: 2025-02-06T04:11:20.414Z (4 months ago)
Topics: cement, cli, cli-app, command-line, makefile, numpy, oanda, pypi, python
Language: Python
Homepage: https://fearlessspider.com/
Size: 20.5 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

README

# Spider Optic forex guider

## Installation

```
$ pip install -r requirements.txt

$ pip install setup.py
```

## Development

This project includes a number of helpers in the `Makefile` to streamline common development tasks.

### Environment Setup

The following demonstrates setting up and working with a development environment:

```
### create a virtualenv for development

$ make virtualenv

$ source env/bin/activate

### run spideroptic cli application

$ spideroptic --help

### run pytest / coverage

$ make test
```

### Releasing to PyPi

Before releasing to PyPi, you must configure your login credentials:

**~/.pypirc**:

```
[pypi]
username = YOUR_USERNAME
password = YOUR_PASSWORD
```

Then use the included helper function via the `Makefile`:

```
$ make dist

$ make dist-upload
```

## Deployments

### Docker

Included is a basic `Dockerfile` for building and distributing `Spider Optic CLI`,
and can be built with the included `make` helper:

```
$ make docker

$ docker run -it spideroptic --help
```