Make into a package with Poetry (#1)

* Make into a package with Poetry * Update the README
Iain-S · Nov 30, 2022 · 34215b7 · 34215b7
1 parent 494ee85
commit 34215b7
Show file tree

Hide file tree

Showing 8 changed files with 32 additions and 8 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -2,14 +2,14 @@ language: python
 
 python:
   - "2.7"
-  - "3.6"
+  - "3.7"
 
 install:
   - pip install coverage
   - pip install coveralls
 
 script:
-  - coverage run --source . test_generate_nhs_numbers.py
+  - coverage run --source nhs_number_generator tests/test_generate_nhs_numbers.py
 
 after_success:
   - coveralls
diff --git a/README.md b/README.md
@@ -3,14 +3,14 @@
 [![Coverage Status](https://coveralls.io/repos/github/Iain-S/nhs_number_generator/badge.svg?branch=master)](https://coveralls.io/github/Iain-S/nhs_number_generator?branch=master)
 [![Build Status](https://travis-ci.org/Iain-S/nhs_number_generator.svg?branch=master)](https://travis-ci.org/Iain-S/nhs_number_generator)
 
-Generate and validate NHS numbers in Python 2.7+ and 3.
+Generate and validate NHS numbers in Python 2.7+ and 3.6+.
 
 ## To use as a script
 
 Generate five (-n 5) sequential (-d) formatted (-f) nhs numbers:
 
 ```
-$ python3 generate_nhs_numbers.py -n 5 -d -f
+$ python -m nhs_number_generator.generate_nhs_numbers -n 5 -d -f
 400 000 0004
 400 000 0012
 400 000 0020
@@ -21,7 +21,7 @@ $ python3 generate_nhs_numbers.py -n 5 -d -f
 Use the -h flag for help:
 
 ```
-$ python3 generate_nhs_numbers.py -h
+$ python -m nhs_number_generator.generate_nhs_numbers -h
 usage: generate_nhs_numbers.py [-h] [-n N] [-d] [-f]
 
 Generate 10-digit NHS numbers.
@@ -36,7 +36,7 @@ optional arguments:
 ## To use as a library
 
 ```python
-import generate_nhs_numbers
+from nhs_number_generator import generate_nhs_numbers
 
 for nhs_number in generate_nhs_numbers.random_nhs_number_generator([(489000000, 489999999)]):
     print(nhs_number)

diff --git a/nhs_number_generator/__init__.py b/nhs_number_generator/__init__.py
diff --git a/generate_nhs_numbers.py → nhs_number_generator/generate_nhs_numbers.py b/generate_nhs_numbers.py → nhs_number_generator/generate_nhs_numbers.py
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,16 @@
+[tool.poetry]
+name = "nhs-number-generator"
+version = "1.0.0"
+description = ""
+authors = ["Iain <[email protected]>"]
+license = "GPLv3"
+readme = "README.md"
+packages = [{include = "nhs_number_generator"}]
+
+[tool.poetry.dependencies]
+python = "^2.7 || ^3.6"
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
diff --git a/tests/.test_generate_nhs_numbers.py.swp b/tests/.test_generate_nhs_numbers.py.swp
diff --git a/test_generate_nhs_numbers.py → tests/test_generate_nhs_numbers.py b/test_generate_nhs_numbers.py → tests/test_generate_nhs_numbers.py
@@ -2,9 +2,9 @@
 
 from __future__ import unicode_literals
 import unittest
-from generate_nhs_numbers import (deterministic_nhs_number_generator, add_separators, calculate_check_digit,
+from nhs_number_generator.generate_nhs_numbers import (deterministic_nhs_number_generator, add_separators, calculate_check_digit,
                                   random_nhs_number_generator, is_valid_nhs_number, remove_separators)
-import generate_nhs_numbers
+from nhs_number_generator import generate_nhs_numbers
 import sys
 
 if sys.version_info.major >= 3:  # pragma: no cover