diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index be00e6c..04f2c40 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -2,54 +2,49 @@ name: tests on: push: - branches: ["master"] + branches: [master] pull_request: - branches: ["master"] + branches: [master] workflow_dispatch: jobs: tests-3x: - name: "Python ${{ matrix.python-version }}" - runs-on: "ubuntu-latest" + name: Python ${{ matrix.py-version }} + runs-on: ubuntu-latest strategy: matrix: - python-version: + py-version: - "3.8" - "3.9" - "3.10" - "3.11" - "3.12" + - "3.13" steps: - - uses: "actions/checkout@v3" - - uses: "actions/setup-python@v4" + - uses: actions/checkout@v4 + - uses: actions/setup-python@v5 with: - python-version: "${{ matrix.python-version }}" - - name: "Install dependencies" - run: | - set -xe - python -VV - python -m pip install -e .[dev] - - name: "Run tests for ${{ matrix.python-version }}" - run: python -m pytest + py-version: ${{ matrix.py-version }} + - name: Install dependencies + run: pip install -e .[dev] + - name: Run tests for ${{ matrix.py-version }} + run: pytest - name: Upload coverage to Codecov - uses: "codecov/codecov-action@v3" + uses: codecov/codecov-action@v5 tests-27: - name: "Python 2.7 on ubuntu-20.04" + name: Python 2.7 on ubuntu-20.04 runs-on: ubuntu-20.04 container: image: python:2.7-buster steps: - - uses: "actions/checkout@v3" - - name: "Install dependencies" - run: | - set -xe - python -VV - python -m pip install -e .[dev] - - name: "Run tests for 2.7" - run: python -m pytest + - uses: actions/checkout@v4 + - name: Install dependencies + run: pip install -e .[dev] + - name: Run tests for 2.7 + run: pytest - name: Upload coverage to Codecov - uses: "codecov/codecov-action@v3" + uses: codecov/codecov-action@v5 diff --git a/README.md b/README.md new file mode 100644 index 0000000..e6a4280 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# luddite + +[![actions](https://github.com/jumptrading/luddite/actions/workflows/tests.yml/badge.svg)](https://github.com/jumptrading/luddite/actions/workflows/tests.yml/) +[![codecov](https://codecov.io/gh/jumptrading/luddite/branch/master/graph/badge.svg)](https://codecov.io/gh/jumptrading/luddite) +[![pypi](https://img.shields.io/pypi/v/luddite.svg)](https://pypi.org/project/luddite/) +![pyversions](https://img.shields.io/pypi/pyversions/luddite.svg) + +`luddite` checks if pinned versions in your `requirements.txt` file have +newer versions in the package index. It's great to be near the cutting +edge, but not so close that you get cut! This tool will help you keep +things up to date manually. + +There are [many ways to specify requirements][1], but luddite's only +interested in one: we're looking for `package==version` pins. Parsing +won't break on lines that aren't fitting this format, but you'll have +to check them manually. + +`luddite` works on both Python 2 and Python 3. + +### Installation + +```bash +pip install luddite +``` + +### Usage + +```bash +luddite /path/to/requirements.txt +``` + +If you are in the same directory as the `requirements.txt` file, you can +just type `luddite`. + +### Example output + +![image](https://user-images.githubusercontent.com/6615374/43939075-feec4530-9c2c-11e8-9770-6f7f762c72e4.png) + +[1]: https://pip.pypa.io/en/stable/reference/requirements-file-format/ diff --git a/README.rst b/README.rst deleted file mode 100644 index fa3183f..0000000 --- a/README.rst +++ /dev/null @@ -1,43 +0,0 @@ -luddite -======= - -|actions|_ |codecov|_ |pypi|_ |pyversions|_ - -.. |actions| image:: https://github.com/jumptrading/luddite/actions/workflows/tests.yml/badge.svg -.. _actions: https://github.com/jumptrading/luddite/actions/workflows/tests.yml/ - -.. |codecov| image:: https://codecov.io/gh/jumptrading/luddite/branch/master/graph/badge.svg -.. _codecov: https://codecov.io/gh/jumptrading/luddite - -.. |pypi| image:: https://img.shields.io/pypi/v/luddite.svg -.. _pypi: https://pypi.org/project/luddite/ - -.. |pyversions| image:: https://img.shields.io/pypi/pyversions/luddite.svg -.. _pyversions: - - -``luddite`` checks if pinned versions in your ``requirements.txt`` file have newer versions in the package index. It's great to be near the cutting edge, but not so close that you get cut! This tool will help you keep things up to date manually. - -There are `many ways to specify requirements `_ in those files, but luddite's parsing is pretty dumb and simple: we're only looking for ``package==version`` pins. It won't break on lines that aren't fitting this format, but you'll have to check them manually. - -``luddite`` works on both Python 2 and Python 3. - - -Installation ------------- - -``pip install luddite`` - - -Usage ------ - -``luddite /path/to/requirements.txt`` - -If you are in the same directory as the ``requirements.txt`` file, you can just type ``luddite``. - - -Example output --------------- - -.. image:: https://user-images.githubusercontent.com/6615374/43939075-feec4530-9c2c-11e8-9770-6f7f762c72e4.png diff --git a/setup.py b/setup.py index 85cf94e..c505724 100644 --- a/setup.py +++ b/setup.py @@ -8,7 +8,7 @@ url="https://github.com/jumptrading/luddite", py_modules=["luddite"], description="Checks for out-of-date package versions", - long_description=open("README.rst").read(), + long_description=open("README.md").read(), classifiers=[ "Programming Language :: Python :: 2", "Programming Language :: Python :: 3",