Skip to content

Commit 202ddb2

Browse files
author
Steve Peak
committed
Update README.md
1 parent b1598e3 commit 202ddb2

File tree

1 file changed

+28
-16
lines changed

1 file changed

+28
-16
lines changed

README.md

+28-16
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,30 @@ pip install codecov
1515
codecov --token=<repo token>
1616
```
1717

18-
# [![travis-org](https://avatars2.githubusercontent.com/u/639823?v=2&s=50)](https://travis-ci.org) Travis CI
18+
## Using `tox`?
19+
Codecov can be ran from inside your `tox.ini` please make sure you pass all the necessary environment variables through:
20+
21+
```
22+
[testenv]
23+
passenv = CI TRAVIS_BUILD_ID TRAVIS TRAVIS_BRANCH TRAVIS_JOB_NUMBER TRAVIS_PULL_REQUEST TRAVIS_JOB_ID TRAVIS_REPO_SLUG TRAVIS_COMMIT
24+
deps = codecov>=1.4.0
25+
commands = codecov -e TOXENV
26+
```
27+
> See all the environment variable for other CI providers [here](https://github.com/codecov/codecov-python/blob/master/codecov/__init__.py#L260-L430). Note the `-e TOXENV` is used to distinquish builds in Codecov UI [example](https://codecov.io/gh/pyca/cryptography?ref=99c45f19be196cb45bf8de8ea105fcb4619ab504&build=7312.1).
28+
29+
## Private repositories
30+
Please provide your private repository token (found at Codecov) to upload reports.
31+
32+
```
33+
export CODECOV_TOKEN=:token
34+
codecov
35+
# or
36+
codecov -t :token
37+
```
38+
39+
# Some example CI providers
40+
41+
### [![travis-org](https://avatars2.githubusercontent.com/u/639823?v=2&s=50)](https://travis-ci.org) Travis CI
1942
> Append to your `.travis.yml`
2043
2144
```yml
@@ -25,29 +48,18 @@ after_success:
2548
codecov
2649
```
2750
28-
> ### Start testing with [Travis](https://travis-ci.org/)
29-
30-
# [![codeship](https://avatars1.githubusercontent.com/u/2988541?v=2&s=50)](https://codeship.io/) Codeship
31-
> Append to your `Test Commands` *after* your test commands
32-
33-
```sh
34-
pip install codecov
35-
codecov --token=<repo token>
36-
```
37-
38-
> ### Start testing with [Codeship](https://codeship.io/)
51+
> Note: No need to include a repository token for **public** repos on Travis
3952
4053
41-
# [![circleci](https://avatars0.githubusercontent.com/u/1231870?v=2&s=50)](https://circleci.com/) Circle CI
54+
### [![circleci](https://avatars0.githubusercontent.com/u/1231870?v=2&s=50)](https://circleci.com/) [Circle CI](https://circleci.com/).
4255
> Append to your `circle.yml` file
4356

4457
```yml
4558
test:
4659
post:
47-
- pip install codecov
48-
- codecov --token=<repo token>
60+
- pip install codecov && codecov
4961
```
50-
> ### Start testing with [Circle CI](https://circleci.com/)
62+
> Note: No need to include a repository token for **public** repos on CircleCI
5163

5264

5365

0 commit comments

Comments
 (0)