diff --git a/.gitignore b/.gitignore index 27d316b..048c4d6 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,6 @@ *.pyc -/helloworld.egg-info +/MANIFEST +/build/ +/deb_dist/ +/dist/ +/helloworld.egg-info/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..731d3f0 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1 @@ +include helloworld/VERSION.txt \ No newline at end of file diff --git a/README b/README deleted file mode 100644 index 6939fb7..0000000 --- a/README +++ /dev/null @@ -1,4 +0,0 @@ -Hello, World -============ - -A simple program, and an example of how to structure a python project. diff --git a/README.md b/README.md new file mode 100644 index 0000000..facdc94 --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +Hello, World +============ + +A simple program, and an example of how to structure a python project. Demonstrates a basic package +file structure (using [flat layout]) and a way to define a [single package version] shared between +package metadata and program runtime. + +See also: the Python Packaging User Guide at https://packaging.python.org/ offers more complete +examples and explanations. + +[flat layout]: https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/ +[single package version]: https://packaging.python.org/en/latest/guides/single-sourcing-package-version/ + +Basic usage +----------- + +You can install the package using `pip` and then run the main script from the command line as +`helloworld_in_python` or import it in python via `import helloworld`: + +```shell +$ cd python-helloworld/ # Dir containing this repo's root +$ pip install . +$ helloworld_in_python +Hello, world +$ helloworld_in_python --version +helloworld 0.1 +$ python +>>> import helloworld +>>> helloworld.__version__ +'0.1' +``` + +You can also try it without installing by running `python helloworld.py` in the repository root: + +```shell +$ python helloworld.py +Hello, world +$ python helloworld.py --version +helloworld 0.1 +``` diff --git a/VERSION.txt b/VERSION.txt new file mode 120000 index 0000000..cdcc3f5 --- /dev/null +++ b/VERSION.txt @@ -0,0 +1 @@ +helloworld/VERSION.txt \ No newline at end of file diff --git a/helloworld.py b/helloworld.py index 07da8cb..59701db 100755 --- a/helloworld.py +++ b/helloworld.py @@ -1,4 +1,7 @@ #!/usr/bin/env python + +"""Top-level script to invoke helloworld implementation.""" + import sys import helloworld.main diff --git a/helloworld/VERSION.txt b/helloworld/VERSION.txt new file mode 100644 index 0000000..49d5957 --- /dev/null +++ b/helloworld/VERSION.txt @@ -0,0 +1 @@ +0.1 diff --git a/helloworld/__init__.py b/helloworld/__init__.py index e69de29..87ed1f7 100644 --- a/helloworld/__init__.py +++ b/helloworld/__init__.py @@ -0,0 +1,5 @@ +def __read_version_txt(): + import pkgutil + return pkgutil.get_data('helloworld', 'VERSION.txt').decode('utf-8').strip() + +__version__ = __read_version_txt() diff --git a/helloworld/main.py b/helloworld/main.py index a5929fa..10567a6 100644 --- a/helloworld/main.py +++ b/helloworld/main.py @@ -1,9 +1,26 @@ +"""Top-level implementation of the helloworld program.""" + +import argparse import sys +import helloworld + + +parser = argparse.ArgumentParser( + description='A simple example program to print a friendly greeting.') +parser.add_argument('--version', action='version', + version='helloworld ' + helloworld.__version__) + + def main(argv=None): if argv is None: argv = sys.argv - print "Hello, world" + # The helloworld program doesn't expect any arguments. + # This just checks for the special --version and --help arguments and + # ensures the user hasn't passed any other unrecognized arguments. + parser.parse_args(argv[1:]) + + print("Hello, world") return 0 diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..ed95f86 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,28 @@ +[build-system] +# pyproject.toml support added in 61.0.0, but for some reason fails to process +# this file until version 62. +requires = ["setuptools >= 62"] +build-backend = "setuptools.build_meta" + +[project] +name = "helloworld" +# version is populated by setuptools in setup.py (from VERSION.txt) +dynamic = ["version"] +description = "The familiar example program in Python" +# Newer versions of setuptools (that can detect metadata in pyproject.toml) +# don't seem to support python 2 anymore. +requires-python = ">= 3" +readme = "README.md" +license = { file = "LICENSE" } +authors = [ + { name = "A. Developer", email = "author@example.com" } +] +keywords = ["example", "documentation", "tutorial"] + +[project.urls] +Homepage = "http://github.com/dbarnett/python-helloworld" +Repository = "http://github.com/dbarnett/python-helloworld" + +# command-line executables to expose +[project.scripts] +helloworld_in_python = "helloworld.main:main" \ No newline at end of file diff --git a/setup.py b/setup.py index 06408e1..b706eb0 100644 --- a/setup.py +++ b/setup.py @@ -1,26 +1,12 @@ -import sys +import io +import os.path from setuptools import setup +VERSION_PATH = os.path.join( + os.path.dirname(__file__), 'helloworld/VERSION.txt') +with io.open(VERSION_PATH, 'r', encoding='utf-8') as f: + version = f.read().strip() + setup( - name = "helloworld", # what you want to call the archive/egg - version = "0.1", - packages=["helloworld"], # top-level python modules you can import like - # 'import foo' - dependency_links = [], # custom links to a specific project - install_requires=[], - extras_require={}, # optional features that other packages can require - # like 'helloworld[foo]' - package_data = {}, - author="David Barnett", - author_email = "davidbarnett2@gmail.com", - description = "The familiar example program in Python", - license = "BSD", - keywords= "example documentation tutorial", - url = "http://github.com/dbarnett/python-helloworld", - entry_points = { - "console_scripts": [ # command-line executables to expose - "helloworld_in_python = helloworld.main:main", - ], - "gui_scripts": [] # GUI executables (creates pyw on Windows) - } + version = version, )