Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pip-tools-workflow #9

Closed
dfee opened this issue Jun 30, 2017 · 4 comments
Closed

pip-tools-workflow #9

dfee opened this issue Jun 30, 2017 · 4 comments
Labels
blog comment Comments and feedback on articles

Comments

@dfee
Copy link

dfee commented Jun 30, 2017

@jamescooke wanted to provide you with an updated copy of my makefile (for your use or others). ref

The modifications I've made allow one to compile requirements.txt files (specifically base.txt and test.txt in this case) so that they can be pip-installed from the project's root directory.

Like your structure, I have my req files in $PROJECT_ROOT/requirements/{*.in,*.txt}. However, these modifications are helpful so that I can:

  1. push my code to repo shared by a team, and
  2. use tox to install my requirements for me.
# From James Cooke's blog:
# "A successful pip-tools workflow for managing Python package requirements"
# http://jamescooke.info/a-successful-pip-tools-workflow-for-managing-python-package-requirements.html
.PHONY: all check clean

RELATIVE_PROJECT_ROOT = .. # relative path to project's root
PROJECT_ROOT = $(shell realpath $(RELATIVE_PROJECT_ROOT))
REQUIREMENTS_ROOT = $(shell realpath --relative-to $(PROJECT_ROOT) .)
objects = $(wildcard *.in)
outputs := $(objects:.in=.txt)

all: $(outputs)

%.txt: %.in
        @pushd $(PROJECT_ROOT) > /dev/null; \
        pip-compile --output-file $(REQUIREMENTS_ROOT)/$@ $(REQUIREMENTS_ROOT)/$<; \
        popd > /dev/null; \
        sed -i '' "s|file://$(PROJECT_ROOT)|.|" $@

test.txt: base.txt

check:
        @which pip-compile > /dev/null

clean: check
        - rm *.txt
@jamescooke jamescooke added the blog comment Comments and feedback on articles label Aug 23, 2018
@gsakkis
Copy link

gsakkis commented Sep 15, 2019

@jamescooke @dfee I came across James' blog post which is pretty close to my desired workflow. The challenge I have at the moment is how to integrate it in a broader Makefile that also takes care of installing the (compiled via pip-compile) dependencies. I posted my question on StackOverflow, if you happen to have dealt with (or worked around) this issue it would be great to share it here and/or there.

@jamescooke
Copy link
Owner

I've pinged you on the StackOverflow question 👍

@gsakkis
Copy link

gsakkis commented Sep 16, 2019

Thanks!

@jimustafa
Copy link

A cookiecutter template implementing this workflow is being developed at https://github.com/jimustafa/cookiecutter-pylib-reqm.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blog comment Comments and feedback on articles
Projects
None yet
Development

No branches or pull requests

4 participants