Rqmts

Rqmts - Generate requirements.txt file for any project by analysing package imports


Click here to see the demo.
Click here for documentation.

About the project

Rqmts is a fantastic stand-alone tool which generates requirements.txt file for any project by analysing package imports.

It does not requires any dependency (works out-of-the-box), not needs internet to work (is completely offline, upto this moment), nor uses regular expressions in such a violent way as existing projects do. Instead, it uses simple heuristic techniques and parse conditional trees, which is a better method for extracting imported names from statements, functions, etc.

Why this project

Questions

• Why not just use pip's freeze command to generate a requirements.txt file for my project?
• Why to re-invent the wheel when there are modules such as pipreqs, pigar, poetry already present?
• Why not manually?

Answers

• Why not just pip freeze?
  • pip freeze only saves the packages that are installed with pip install in your environment.
  • pip freeze saves all packages in the environment including those that you don't use in your current project. (if you don't have virtualenv)
• Why re-invent the wheel (?)
  • pipreqs fails on many occasions (see - pipreqs/issues)
  • pigar queries pypi servers, big no-no. Ideally, it should be local, on fallback? then maybe. Other than that, pigar recommends using Pipenv (pipenv has serious issues)
  • poetry quotes "Be aware, however, that it will also install poetry's dependencies which might cause conflicts."
  • Sheer curiousity. "can I create a project that has potential of collecting thosands of stars and most importantly, hundreds of contributors?"
• Manually?
  • Are you serious right now?

Installation

Use pip to install rqmts. This is the recommended way of running Rqmts.

Rqmts also provides a script that will run a rqmts instance isolated from the rest of your system by using file-less/memory-based execution.

curl -sSL https://raw.githubusercontent.com/0x48piraj/rqmts/master/Rqmts.py | python

Alternatively, you can download Rqmts.py from the root directory and execute it separately.

Usage

Command-line Interface and Interactive mode

Challenges

The major challenge of this project is to extract the required metadata from modules which are first extracted from the input script.

• Version numbers in python can be in very different places depending on the case
• Package name in the package index is independent of the module name we import

and these quirks make this project interesting. There's a funny comment in the source which reflects the diversity between us and it goes like :

# module_name.__version__ sucks, because we suck (PEP 0396)

This project aims to combine the best existing strategies to cover the broadest possible set of cases (if not all). The project was built keeping in mind the modular programming paradigms and so other than being readable it's easily extensible making it possible to add new strategies/algorithms quickly.

Changelog

Playing with different versions? Read the Changelog.

Contribute

All patches are Welcome! Please see CONTRIBUTING.md for further details. For discussions, create a new issue or ping me over Twitter

Again, if you have any issues or suggestions/patches, please do not hesitate to open an issue or a pull request!

Running the tests

This project uses unittest.

The Python unit testing framework, sometimes referred to as "PyUnit," is a Python language version of JUnit, by Kent Beck and Erich Gamma. JUnit is, in turn, a Java version of Kent’s Smalltalk testing framework. Each is the de facto standard unit testing framework for its respective language.

You may need to install the package (rqmts) for setup beforehand, using

pip install --user rqmts

All tests are encapsulated in one single script named testsuite.py and all the respective test-cases are under tests/testcases/

For getting started,

python tests/testsuite.py

License

This software is licensed under BSD 3-Clause "New" or "Revised" License. To view a copy of this license, visit BSD 3-Clause.