Skip to content

Commit

Permalink
Separate maintainer requirements from local dev requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
medmunds committed Nov 2, 2018
1 parent 183df95 commit 07e6de5
Show file tree
Hide file tree
Showing 4 changed files with 153 additions and 38 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ ifeq ($(strip $(PIPENV)),)
else ifeq ($(shell which $(PIPENV)),)
$(error Can't find $(PIPENV); see https://pipenv.readthedocs.io/ to install)
else
$(PIPENV) install --dev
$(PIPENV) install
endif


Expand Down
12 changes: 8 additions & 4 deletions Pipfile
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
# This project uses pipenv only to manage the development environment.
# Actual package dependencies are tracked in setup.py.

[[source]]
url = "https://pypi.org/simple"
verify_ssl = true
name = "pypi"

[packages]

[dev-packages]
# boto3 included in Lambda Execution Environment
# https://docs.aws.amazon.com/lambda/latest/dg/current-supported-versions.html
# Packages required for custom builds and testing
awscli = "*"
boto3 = "*"
botocore = "*"
cfn-lint = "*"

[dev-packages]
# Additional packages required for maintaining/releasing this project
python-gitlab = "*"
twine = "*"

[requires]
python_version = "3.6"
168 changes: 139 additions & 29 deletions Pipfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -377,13 +377,14 @@ Development requires GNU Make (standard on most Linux-like systems) and [pipenv]
tracked in `setup.py`.)

To set up your development environment, clone the repository and then run `make init`.
(This just runs `pipenv install --dev`.)
(This just runs `pipenv install`. If you are a package maintainer who will release
to PyPI, use `pipenv install --dev` instead.)

To see a list of available make targets, run `make help`.

To package and upload your own version of the Lambda zip package and the templates,
run `make S3_BUCKET=your_bucket_name upload`. If you just want to build locally
without uploading to S3, run `make S3_BUCKET=your_bucket_name all`. You can also
To package and upload your own version of the Lambda zip package and the CloudFormation
templates, run `make S3_BUCKET=your_bucket_name upload`. If you just want to build
locally without uploading to S3, run `make S3_BUCKET=your_bucket_name all`. You can also
include `S3_PREFIX=your/s3/prefix` or `S3_PREFIX=` in either of these commands,
if desired.

Expand Down

0 comments on commit 07e6de5

Please sign in to comment.