diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000000000000000000000000000000000..46889c9fc0057c14161f2a0b403d437749b23c04 --- /dev/null +++ b/.gitignore @@ -0,0 +1,60 @@ +~* +*~ +*.sw[op] +*.py[cod] +.DS_Store +__pycache__/ +__pypackages__/ +.vagrant/ +vendor/ +Thumbs.db +*.retry +.svn/ +.sass-cache/ +*.log +*.out +*.so +node_modules/ +.npm/ +nbproject/ +*.ipynb +.idea/ +*.egg-info/ +*.[ao] +.classpath +.cache/ +bower_components/ +*.class +*.[ewj]ar +secring.* +.*.kate-swp +.swp.* +.directory +.Trash-* +build/ +_build/ +dist/ +.tox/ +*.pdf +*.exe +*.dll +*.gz +*.tgz +*.tar +*.rar +*.zip +*.xz +*.pid +*.lock +*.env +.bundle/ +!Pipfile.lock +!pdm.lock +!Gemfile.lock +.terraform +.terraform.* +!.terraform.lock.hcl +tfplan +*.tfstate* +*.venv +reports/ diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000000000000000000000000000000000000..6cca52a021eaa3fc1ab6c0c24012dad7284b8f08 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022 Adar Nimrod + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000000000000000000000000000000000000..34fe6d16372640b489dc432034a725c95efb9ce1 --- /dev/null +++ b/README.rst @@ -0,0 +1,23 @@ +Sample Python project +##################### + +A sample Python project. Meant as an instruction on creating a modern Python +package with just the standard Python tooling (setuptools, wheel) and without +additional tools like `Poetry <https://python-poetry.org/>`_, `Flit +<https://flit.pypa.io/>`_ or similar. This mainly revolves around using +:code:`pyproject.toml` in a standard wasy as specified in `PEP 621 +<https://peps.python.org/pep-0621/>`_. + +License +------- + +This software is licensed under the MIT license (see the :code:`LICENSE.txt` +file). + +Author +------ + +Nimrod Adar, `contact me <nimrod@shore.co.il>`_ or visit my `website +<https://www.shore.co.il/>`_. Patches are welcome via `git send-email +<http://git-scm.com/book/en/v2/Git-Commands-Email>`_. The repository is located +at: https://git.shore.co.il/nimrod/.