Skip to content
This repository has been archived by the owner on Apr 20, 2023. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Steve Peak authored Aug 3, 2016
1 parent d483f0c commit b64d313
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Find coverage reports for all the [languages below](#languages), gather them and
## Usage

```sh
pip install --user codecov && codecov --token=<repo token>
pip install --user codecov && codecov -t the-repository-upload-token
```
> `--user` argument not needed for Python projects. [See example here](https://github.com/codecov/example-python).
Expand All @@ -35,7 +35,7 @@ passenv = CI TRAVIS_BUILD_ID TRAVIS TRAVIS_BRANCH TRAVIS_JOB_NUMBER TRAVIS_PULL_
deps = codecov>=1.4.0
commands = codecov -e TOXENV
```
> See all the environment variables for other CI providers [here](https://github.com/codecov/codecov-python/blob/master/codecov/__init__.py#L260-L430)
> See all the environment variables for other CI providers [here](https://github.com/codecov/codecov-python/blob/master/codecov/__init__.py#L254-L468)

## Configuration
Expand All @@ -45,7 +45,8 @@ commands = codecov -e TOXENV
| Argument | Environment | Description |
| -------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `-t` | `CODECOV_TOKEN` | Private repo token for uploading |
| `-e` | `CODECOV_ENV` | List of config vars to store for the build [see example](https://codecov.io/github/pyca/cryptography?ref=d47946f3d3e358b706e996d0b951d496ffc2461f) |
| `-e` | `CODECOV_ENV` | List of config vars to store for the build |
| `-F` | | Flag this upload to group coverage reports. Ex. `unittests` or `integration` |

```yaml
# public repository on Travis CI
Expand All @@ -60,7 +61,7 @@ after_success:
install:
- pip install --user codecov
after_success:
- codecov -t :repo-token
- codecov -t the-repository-upload-token
```
Expand Down

0 comments on commit b64d313

Please sign in to comment.