Skip to content

Commit

Permalink
Added Local development section to README.md and simplified proce…
Browse files Browse the repository at this point in the history
…ss to upload new packages to the Python Package Indexes
  • Loading branch information
Nicklas Reincke committed Nov 19, 2018
1 parent 6042537 commit c8571f2
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 2 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,18 @@ get_marriage_years | Element individual |List of Int| Returns Marriage even
print_gedcom | none | none | Prints the gedcom to STDOUT
save_gedcom | String filename | none | Writes gedcom to specified filename

## Local development

Local development is powered with [Docker Compose](https://docs.docker.com/compose/).

### Uploading a new package to PyPI

1. Run `docker-compose run --rm python python3 setup.py sdist bdist_wheel` to generate distribution archives
1. Run `docker-compose run --rm python twine upload --repository-url https://test.pypi.org/legacy/ dist/*` to upload the archives to the Test Python Package Index repository

> When the package is ready to be published to the real Python Package Index
the URL is `repository-url` is `https://upload.pypi.org/legacy/`.

## History

This module was originally based on a GEDCOM parser written by
Expand Down
5 changes: 3 additions & 2 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
version: '2'
version: '3'

services:

python:
build: ./
build:
context: ./
volumes:
- ./:/usr/src/app:z
3 changes: 3 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
setuptools
wheel
twine

0 comments on commit c8571f2

Please sign in to comment.