-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.md.jinja2
62 lines (42 loc) · 2.25 KB
/
README.md.jinja2
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# prosper-bot
Bot to automatically invest in prosper.com
[](https://github.com/grahamtt/prosper-bot)
[](https://pypi.org/project/prosper-bot/)
[](https://codeclimate.com/github/grahamtt/prosper-bot)
[](https://codeclimate.com/github/grahamtt/prosper-bot)
[](https://www.bestpractices.dev/projects/8107)
## Installation
Use [`pipx`](https://pypa.github.io/pipx/) to install in a self-contained virtual environment.
```bash
pipx install prosper-bot
```
## Setup
Follow the [setup instructions](https://github.com/grahamtt/prosper-api#setup) for Prosper API
## Running
### Dry run
```bash
prosper-bot --dry-run
```
### For realsies
```bash
prosper-bot
```
## Options
Prosper bot exposes all the config options from `prosper-api`, plus the options in the `bot` and `cli` sections below.
```yaml
{{config_options}}
```
All configs can be provided as command-line options as well:
```
{{cli_options}}
```
## Feedback
This project uses [GitHub issues](https://github.com/grahamtt/prosper-bot/issues) for feature requests and bug reports.
## Contributing
This project uses [Poetry](https://python-poetry.org/docs/) to manage dependencies and building. Follow the instructions
to install it. Then use `poetry install --all-extras` to install the project dependencies. Then run `poetry run autohooks activate`
to set up the pre-commit hooks. Please ensure the hooks pass before submitting a pull request.