Merge pull request codecov#68 from codecov/simplify

fix: simplify repository and update deps

Author: thomasrockhu-codecov

.circleci/config.yml

@@ -1,21 +1,19 @@
 version: 2.1
 orbs:
-  codecov: codecov/codecov@3.0.0
+  codecov: codecov/codecov@3
 
 jobs:
   build:
     docker:
-      - image: cimg/python:3.9.6
+      - image: cimg/python:3.10
     steps:
       - checkout
       - run:
           name: Install dependencies
           command: pip install -r requirements.txt
       - run:
           name: Run tests and collect coverage
-          command: |
-            coverage run tests.py
-            coverage xml
+          command: pytest --cov app
       - codecov/upload
 
 workflow:

.github/workflows/ci.yml

@@ -6,15 +6,13 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v2
-      - name: Set up Python 3.9
+      - name: Set up Python 3.10
         uses: actions/setup-python@v2
         with:
-          python-version: 3.9
+          python-version: '3.10'
       - name: Install dependencies
         run: pip install -r requirements.txt
       - name: Run tests and collect coverage
-        run: |
-          coverage run tests.py
-          coverage xml
+        run: pytest --cov app
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v2
+        uses: codecov/codecov-action@v3

README.md

@@ -1,92 +1,18 @@
 # [Codecov](https://codecov.io) Python Example
+[![codecov](https://codecov.io/github/codecov/example-python/branch/master/graph/badge.svg?token=tkq655ROg3)](https://codecov.io/github/codecov/example-python)
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fcodecov%2Fexample-python.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fcodecov%2Fexample-python?ref=badge_shield)
 
+This example repository shows how Codecov can be integrated with a simple python project. It uses **GitHub Actions** and **CircleCI** as CI/CD providers and **coverage** as the coverage provider.
 
-## Guide
-
-### GitHub Actions
-A minimal configuration might look like:
-
-```yml
-steps:
-  # (Other steps go here)
-  - name: "Upload coverage to Codecov"
-    uses: codecov/codecov-action@v2
-    with:
-      fail_ci_if_error: true
-      token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
-```
-
-See [codecov/codecov-action](https://github.com/codecov/codecov-action) for
-more information, a [detailed example](https://github.com/codecov/codecov-action#example-workflowyml-with-codecov-action),
-and other options.
-
-### Produce Coverage Reports
-[coverage.py](https://github.com/nedbat/coveragepy) is required to collect coverage metrics.
-
-Below are some examples on how to include coverage tracking during your tests. You will need to call `coverage xml` to generate the coverage xml output, which will be archived and processed server side.
-
-You may need to configure a `.coveragerc` file. Learn more [here](http://coverage.readthedocs.org/en/latest/config.html). Start with this [generic .coveragerc](https://gist.github.com/codecov-io/bf15bde2c7db1a011b6e) for example.
-
-We highly suggest adding `source` to your `.coveragerc` which solves a number of issues collecting coverage.
-
-```ini
-[run]
-source=your_package_name
-```
-#### unittests
-```
-pip install coverage
-coverage run tests.py
-coverage xml
-```
-#### pytest
-```
-pip install pytest-cov
-pytest --cov=./ --cov-report=xml
-```
-#### nosetests
-```
-nosetest --with-coverage
-```
-See the [Offical Nose coverage docs](http://nose.readthedocs.org/en/latest/plugins/cover.html) for more information.
-
-### Testing with ``tox``
-
-Codecov can be run from inside your `tox.ini` please make sure you pass all the necessary environment variables through:
-```ini
-[testenv]
-passenv = CI TRAVIS TRAVIS_*
-deps = codecov
-commands = codecov
-```
-
-### FAQ
-- Q:  What's the difference between the codecov-bash and codecov-python uploader?  
-  A: As far as python is concerned, *nothing*. You may choose to use either uploader. Codecov recommends **using the bash uploader when possible** as it supports more unique repository setups. Learn more at [codecov/codecov-bash](https://github.com/codecov/codecov-bash) and [codecov/codecov-python](https://github.com/codecov/codecov-python).
-- Q:  Why am I seeing `No data to report`?  
-  A: This output is written by running the command `coverage xml` and states that there were no `.coverage` files found.
-	1. Make sure coverage is enabled. See Enabling Coverage
-	2. You may need to run `coverage combine` before running Codecov.
-	3. Using Docker? Please follow this step: [Testing with Docker: Codecov Inside Docker](https://docs.codecov.io/docs/testing-with-docker#codecov-inside-docker).
-- Q: Can I upload my `.coverage` files?  
-  A: **No**, these files contain coverage data but are not properly mapped back to the source code. We rely on `coveragepy` to handle this by calling `coverage xml` in the uploader.
-
-## Caveats
-### Private Repo
-Repository tokens are required for (a) all private repos, (b) public repos not using the GitHub Actions, Travis CI, CircleCI or AppVeyor.
-
-Find your repository token at Codecov and provide via appending `-t <your upload token>` to you where you upload reports.
-
-### Cobertura Reports
-Cobertura reports can expire - Codecov will reject reports that are older than 12 hours. The logs contain details if a report expired.
+For more information, please see the links below.
 
 ## Links
+- [Quick Start](https://docs.codecov.com/docs/quick-start)
+- [GitHub Tutorial](https://docs.codecov.com/docs/github-tutorial)
 - [Community Boards](https://community.codecov.io)
 - [Support](https://codecov.io/support)
 - [Documentation](https://docs.codecov.io)
 
 
-
 ## License
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fcodecov%2Fexample-python.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fcodecov%2Fexample-python?ref=badge_large)

app/__init__.py

@@ -0,0 +1,14 @@
+class Calculator:
+    def add(x, y):
+        return x + y
+
+    def subtract(x, y):
+        return x - y
+
+    def multiply(x, y):
+        return x * y
+
+    def divide(x, y):
+        if y == 0:
+            return 'Cannot divide by 0'
+        return x * 1.0 / y

app/__pycache__/__init__.cpython-39.pyc

@@ -0,0 +1,31 @@
+from .calculator import Calculator
+
+
+def test_add():
+    assert Calculator.add(1, 2) == 3.0
+    assert Calculator.add(1.0, 2.0) == 3.0
+    assert Calculator.add(0, 2.0) == 2.0
+    assert Calculator.add(2.0, 0) == 2.0
+    assert Calculator.add(-4, 2.0) == -2.0
+
+def test_subtract():
+    assert Calculator.subtract(1, 2) == -1.0
+    assert Calculator.subtract(2, 1) == 1.0
+    assert Calculator.subtract(1.0, 2.0) == -1.0
+    assert Calculator.subtract(0, 2.0) == -2.0
+    assert Calculator.subtract(2.0, 0.0) == 2.0
+    assert Calculator.subtract(-4, 2.0) == -6.0
+
+def test_multiply():
+    assert Calculator.multiply(1, 2) == 2.0
+    assert Calculator.multiply(1.0, 2.0) == 2.0
+    assert Calculator.multiply(0, 2.0) == 0.0
+    assert Calculator.multiply(2.0, 0.0) == 0.0
+    assert Calculator.multiply(-4, 2.0) == -8.0
+
+def test_divide():
+    assert Calculator.divide(1, 2) == 0.5
+    assert Calculator.divide(1.0, 2.0) == 0.5
+    assert Calculator.divide(0, 2.0) == 0
+    assert Calculator.divide(-4, 2.0) == -2.0
+    # assert Calculator.divide(2.0, 0.0) == 'Cannot divide by 0'