https://github.com/amirrh6/requirements.txt

[Draft] Some personally suggested practices for dependency management using requirements.txt file.
https://github.com/amirrh6/requirements.txt

dependency packaging pip pipenv pipfile python requirements

Last synced: 4 days ago
JSON representation

[Draft] Some personally suggested practices for dependency management using requirements.txt file.

• Host: GitHub
• URL: https://github.com/amirrh6/requirements.txt
• Owner: amirrh6
• Created: 2022-09-05T15:18:51.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-09-05T15:50:24.000Z (about 2 years ago)
• Last Synced: 2023-07-21T15:36:33.674Z (over 1 year ago)
• Topics: dependency, packaging, pip, pipenv, pipfile, python, requirements
• Homepage:
• Size: 4.88 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Intro

Some personally suggested practices for dependency management using requirements.txt file.

PRs and issues are welcome!

# The story

From https://github.com/python-poetry/poetry#why :

```

Packaging systems and dependency management in Python are rather convoluted and hard to understand for newcomers. Even for seasoned developers it might be cumbersome at times to create all files needed in a Python project: setup.py, requirements.txt, setup.cfg, MANIFEST.in and Pipfile.

So I wanted a tool that would limit everything to a single configuration file to do: dependency management, packaging and publishing.

It takes inspiration in tools that exist in other languages, like composer (PHP) or cargo (Rust).

And, finally, I started poetry to bring another exhaustive dependency resolver to the Python community apart from Conda's.

```

From https://github.com/python-poetry/poetry#introduction :

```

poetry is a tool to handle dependency installation as well as building and packaging of Python packages. It only needs one file to do all of that: the new, standardized pyproject.toml.

In other words, poetry uses pyproject.toml to replace setup.py, requirements.txt, setup.cfg, MANIFEST.in and Pipfile.

```

# And...

If you don't want to switch to modern solutions like poetry, Pipfile (pip-env) and ..., here are some suggested practices for dependency management using requirements.txt file:

### Suggested methods for updating requirements.txt file

* `pip freeze > requirements.txt`

    * Pros:

        * Already available.

    * Cons:

        * Outputs an absolute path for packages installed directly via file urls (Relative path is preferred).

        

        Current status:

        ```

        ...

        my-custom-module @ file:///home/me/code/my_project/my_custom_module-0.1.0-py3-none-any.whl

        ...

        ```

        

        Prefred:

        ```

        ...

        my-custom-module @ file:///./my_custom_module-0.1.0-py3-none-any.whl

        ...

        ```

* `pip list --format=freeze > requirements.txt`

    * Pros:

        * Already available.

    * Cons:

        * Outputs the version for packages installed directly via file urls, just like other modules (Relative path is preferred).

* `pip-chill > requirements.txt`

    * Pros:

        * Outputs only manually installed packages (without their dependencies).

    * Cons:

        * Just like pip, outputs an absolute path for packages installed directly via file urls (Relative path is preferred).

        * pip_chill package should be manually installed via pip.

* `pip-chill -v > requirements.txt`

    * Pros:

        * Outputs only manually installed packages. Their dependencies are printed as comments.

    * Cons:

        * Just like pip, outputs an absolute path for packages installed directly via file urls (Relative path is preferred).

        * pip_chill package should be manually installed via pip.

### Updating a primary dependency (used in your source code), with / without affecting the package's dependencies

...

### Semantic versioning

...

### ...