Skip to content

Commit

Permalink
README: formatting fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
brutasse committed Jun 3, 2016
1 parent a4c2fa0 commit 0023119
Showing 1 changed file with 21 additions and 14 deletions.
35 changes: 21 additions & 14 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,23 @@ for feature requests, discussion and some development tracking.
Install
=======

pip install py-trello
```
pip install py-trello
```

Usage
=====

from trello import TrelloClient
```python
from trello import TrelloClient
client = TrelloClient(
api_key='your-key',
api_secret='your-secret',
token='your-oauth-token-key',
token_secret='your-oauth-token-secret'
)
client = TrelloClient(
api_key='your-key',
api_secret='your-secret',
token='your-oauth-token-key',
token_secret='your-oauth-token-secret'
)
```

Where `token` and `token_secret` come from the 3-legged OAuth process and
`api_key` and `api_secret` are your Trello API credentials that are
Expand All @@ -47,20 +51,23 @@ https://trello.com/docs/gettingstarted/#getting-a-token-from-a-user

Run

python ./trello/util.py
```
python ./trello/util.py
```

Required Python modules
=======================
Found in requirements.txt

Found in `requirements.txt`

Tests
=====
To run the tests, run `python -m unittest discover`. Four environment variables must be set:

* TRELLO_API_KEY: your Trello API key
* TRELLO_TOKEN: your Trello OAuth token
* TRELLO_TEST_BOARD_COUNT: the number of boards in your Trello account
* TRELLO_TEST_BOARD_NAME: name of the board to test card manipulation on. Must be unique, or the first match will be used
* `TRELLO_API_KEY`: your Trello API key
* `TRELLO_TOKEN`: your Trello OAuth token
* `TRELLO_TEST_BOARD_COUNT`: the number of boards in your Trello account
* `TRELLO_TEST_BOARD_NAME`: name of the board to test card manipulation on. Must be unique, or the first match will be used

To run tests across various Python versions,
[tox](https://tox.readthedocs.io/en/latest/) is supported. Install it
Expand Down

2 comments on commit 0023119

@tinruufu
Copy link

Choose a reason for hiding this comment

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

im v confused about why you've converted this rst file to some weird broken markdown hybrid

@brutasse
Copy link
Contributor Author

Choose a reason for hiding this comment

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

confused as well… I assumed this was markdown, will fix

Please sign in to comment.