Skip to content

Commit

Permalink
ci: disable type static-code-analysis until we have typed the library
Browse files Browse the repository at this point in the history
Signed-off-by: Paul Horton <[email protected]>
  • Loading branch information
madpah committed Dec 17, 2021
1 parent 6f73ee5 commit c8da36d
Show file tree
Hide file tree
Showing 3 changed files with 59 additions and 60 deletions.
7 changes: 4 additions & 3 deletions .github/workflows/poetry.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ jobs:

static-code-analysis:
name: StaticCodingAnalysis (py${{ matrix.python-version}} ${{ matrix.toxenv-factor }})
if: ${{ false }} # disable for now
runs-on: ubuntu-latest
strategy:
fail-fast: false
Expand All @@ -55,9 +56,9 @@ jobs:
- # test with the locked dependencies
python-version: '3.10'
toxenv-factor: 'locked'
# - # test with the lowest dependencies
# python-version: '3.6'
# toxenv-factor: 'lowest'
- # test with the lowest dependencies
python-version: '3.6'
toxenv-factor: 'lowest'
steps:
- name: Checkout
# see https://github.com/actions/checkout
Expand Down
55 changes: 55 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
Requirements Parser
===================

[![Python CI](https://github.com/madpah/requirements-parser/actions/workflows/poetry.yml/badge.svg)](https://github.com/madpah/requirements-parser/actions/workflows/poetry.yml)
[![Documentation Status](http://readthedocs.org/projects/requirements-parser/badge/?version=latest)](http://requirements-parser.readthedocs.io/en/latest/?badge=latest)
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

This is a small Python module for parsing [Pip](http://www.pip-installer.org/) requirement files.

The goal is to parse everything in the
[Pip requirement file format](https://pip.pypa.io/en/stable/reference/pip_install/#requirements-file-format) spec.

Installation
============

pip install requirements-parser

or

poetry add requirements-parser

Examples
========

Requirements parser can parse a file-like object or a text string.

``` {.python}
>>> import requirements
>>> with open('requirements.txt', 'r') as fd:
... for req in requirements.parse(fd):
... print(req.name, req.specs)
Django [('>=', '1.11'), ('<', '1.12')]
six [('==', '1.10.0')]
```

It can handle most if not all of the options in requirement files that
do not involve traversing the local filesystem. These include:

- editables (`-e git+https://github.com/toastdriven/pyelasticsearch.git]{.title-ref}`)
- version control URIs
- egg hashes and subdirectories (`[\#egg=django-haystack&subdirectory=setup]{.title-ref}`)
- extras ([DocParser\[PDF\]]{.title-ref})
- URLs

Documentation
=============

For more details and examples, the documentation is available at:
<http://requirements-parser.readthedocs.io>.


Change Log
==========

Change log is available on GitHub [here]()
57 changes: 0 additions & 57 deletions README.rst

This file was deleted.

0 comments on commit c8da36d

Please sign in to comment.