Merge pull request #53 from capitalone/dev

Release 2022.11.0
capitalone · Nov 7, 2022 · 05c361d · 05c361d
2 parents 028a94a + e8f8585
commit 05c361d
Show file tree

Hide file tree

Showing 15 changed files with 1,298 additions and 104 deletions.
diff --git a/.github/workflows/test-package.yml b/.github/workflows/test-package.yml
@@ -20,6 +20,7 @@ jobs:
                     - 3.7
                     - 3.8
                     - 3.9
+                    - "3.10"
         steps:
             - uses: actions/checkout@v2
             - name: Set up Python ${{ matrix.python-version }}

diff --git a/README.md b/README.md
@@ -4,10 +4,11 @@
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
 [![PyPI version](https://badge.fury.io/py/edgetest.svg)](https://badge.fury.io/py/edgetest)
 [![Anaconda-Server Badge](https://anaconda.org/conda-forge/edgetest/badges/version.svg)](https://anaconda.org/conda-forge/edgetest)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/edgetest)
 
 [Full Documentation](https://capitalone.github.io/edgetest/)
 
-`edgetest` is a `tox`-inspired python library that will loop through your project's dependencies, and check if your 
+`edgetest` is a `tox`-inspired python library that will loop through your project's dependencies, and check if your
 project is compatible with the latest version of each dependency. It does this by:
 
 * creating a virtual environment,
@@ -18,6 +19,14 @@ project is compatible with the latest version of each dependency. It does this b
 For example, if you depend on ``pandas>=0.25.1,<=1.0.0``, ``edgetest`` will test your project against the most current
 pandas version (say ``1.3.4``), so you know if you can safely update your dependency to ``pandas>=0.25.1,<=1.3.4`` or not.
 
+
+`edgetest` works with the following types of projects:
+
+- `pyproject.toml`
+- `setup.cfg`
+- and `requirements.txt`
+
+
 Table Of Contents
 -----------------
 
@@ -47,7 +56,8 @@ $ conda install -c conda-forge edgetest
 Getting Started
 ---------------
 
-``edgetest`` allows multi-package, bleeding edge dependency testing. Suppose you have a package, ``mypackage``, with the following ``requirements.txt``:
+``edgetest`` allows multi-package, bleeding edge dependency testing. Suppose you have a package, ``mypackage``, with
+the following ``requirements.txt``:
 
 ```
 pandas>=0.25.1,<=1.0.0
@@ -118,4 +128,3 @@ Roadmap
 -------
 
 Roadmap details can be found [here](https://capitalone.github.io/edgetest/roadmap.html).
-
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -25,7 +25,7 @@
 author = "Akshay Gupta"
 
 # The short X.Y version
-version = "2022.7.0"
+version = "2022.11.0"
 # The full version, including alpha/beta/rc tags
 release = ""
 

diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst
@@ -16,6 +16,17 @@ Installation from conda-forge:
 
     $ conda install -c conda-forge edgetest
 
+
+Project support type
+--------------------
+
+``edgetest`` works with the following types of projects:
+
+- ``pyproject.toml``
+- ``setup.cfg``
+- and ``requirements.txt``
+
+
 Usage
 -----