Skip to content

Commit 041d77d

Browse files
committed
Update README
1 parent 4b79a17 commit 041d77d

1 file changed

Lines changed: 36 additions & 1 deletion

File tree

README.md

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,13 @@
1010
<br />
1111
</div>
1212

13-
[![Build Status](https://travis-ci.org/OperationCode/operationcode-pybot.svg?branch=master)](https://travis-ci.org/OperationCode/operationcode-pybot)
13+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
14+
[![Twitter Follow](https://img.shields.io/twitter/follow/operation_code.svg?style=social&label=Follow&style=social)](https://twitter.com/operation_code)
15+
[![Code-style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
16+
17+
18+
[![CircleCI](https://circleci.com/gh/OperationCode/operationcode-pybot.svg?style=svg)](https://circleci.com/gh/OperationCode/operationcode-pybot)
19+
[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=OperationCode/operationcode-pybot)](https://dependabot.com)
1420

1521
# [OperationCode-Pybot](https://github.com/OperationCode/operationcode-pybot)
1622

@@ -28,5 +34,34 @@ framework.
2834
## Contributing
2935
Bug reports and pull requests are welcome on [Github](https://github.com/OperationCode/operationcode-pybot). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. If you wish to assist, join the [\#oc-python-projects](https://operation-code.slack.com/messages/C7NJLCCMB/) rewrite to learn how to contribute.
3036

37+
## Quick Start
38+
Recommended versions of tools used within the repo:
39+
- `python@3.7` or greater (in some environments, you may need to specify version of python i.e. `python test.py` vs `python3 test.py`))
40+
- `git@2.17.1` or greater
41+
- `poetry@0.12.11` or greater
42+
- [Poetry](https://poetry.eustace.io/) is a packaging and dependency manager, similar to pip or pipenv
43+
- Poetry provides a custom installer that can be ran via `curl -sSL https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py | python`
44+
- Alternatively, poetry can be installed via pip/pip3 with `pip install --user poetry` or `pip3 install --user poetry`
45+
- See https://poetry.eustace.io/docs/
46+
47+
48+
```bash
49+
# Install dependencies (ensure poetry is already installed)
50+
poetry install
51+
52+
# Run local development
53+
poetry run python -m pybot
54+
55+
# Run testing suite
56+
poetry run pytest
57+
58+
# Run formatting and linting
59+
poetry run black .
60+
# the next line shouldn't output anything to the terminal if it passes
61+
poetry run flake8
62+
poetry run isort -rc .
63+
```
64+
65+
3166
## License
3267
This package is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

0 commit comments

Comments
 (0)