Skip to content

Commit

Permalink
change doc to markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
wimglenn committed Dec 5, 2024
1 parent 141c41b commit 9f96657
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 44 deletions.
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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/
43 changes: 0 additions & 43 deletions README.rst

This file was deleted.

2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit 9f96657

Please sign in to comment.