Package: inception-tools
Under ConstructionHello and welcome to theinception-toolsproject!The goal of this project is to create, foster, and disseminate solid conventions for
Python project structure through the propagation and reuse of project archetypes,
developed and submitted by the community, which can be used as templates for
automatically setting up new Python projects.This project is currently under construction. This documentation describes current
state of application functionality.  The application currently supports a set of
standard archetypessimple - a basic project shellcli - for creating command-line interface projectslib - for developing and publishing a Python librariesSupport for user-defined archetypes is coming. Please check back periodically to
see what’s new.If you would like to see updates or additions to the standard archetypes, the templates
are located in thearchetypesdirectory and are made available to the CLI through
theStandardArchetypeclass. Please submit a PR for review using the instructions in
theBugs, Contribution, and Feedbacksection, or reach out to the author’s email
listed at the bottom of this document.DocumentationCreate a new Python project, ready to go, with a single command!Inception-tools is a command-line application designed to create new software
projects (in particular, Python-based projects) using a set of standardized project
archetypes.The baseinception-toolspackage provides:Simple command-line invocation for creating “stubbed-out” Python projects,
parameterized through the command-line call.A set of standard archetypes for common Python project types:simpleCreates a basic project shell.cliCreates a project shell geared toward developing and publishing a
Python-based command-line application.libCreates a project shell geared specifically toward developing and
publishing a Python libraryEach standard archetype creates a shell project structure with files,
directories, class and function stubs, completely set up and ready for
publication to PyPI using a standardized set of Makefile targets.Python Package Index:https://pypi.org/project/inception-tools/GitHub Repository:https://github.com/inception-tools/inception-toolsInstallationDownload and install the latest version of this application from the Python
package index (PyPI) as follows:pip install inception-toolsNote thatinception-toolshas dependencies on the following packages:clickjinja2These should be automatically installed bypipusing the command-line
above.UsageOnce Inception Tools has been installed, you can create a new project shell
as follows:it incept package_name [project_root]This will create a new project (using the standardapplicationarchetype) under the directoryproject_rootusing additional parameters
stored in fileinception-tools.cfg:<project_root>/
    docs/
    <package_name>/
        __init__.py
        cli.py
    scripts/
    tests/
        __init__.py
        end-to-end/
            __init__.py
        integration/
            __init__.py
        unit/
            __init__.py
    LICENSE
    Makefile
    Pipfile
    README.rst
    setup.cfg
    setup.pypackage_name(required)The package name that will used for your new project, e.g.inception_tools. This will be used to create for the name of the
package, for the name of a stub entry point files, and in the names of
test modules. It will also be used as the relative path for theproject_rootargument in the event that it is omitted (see below).[project_root](optional) default: package_nameThe path to the directory under which your project should be installed,
e.g.inception-tools.Exampleinstalling to a directory my_package in the current working
directory:it incept my_packageExampleinstalling to a directory called my_project in the user’s home
directory:it incept my_package ~/my_projectThe following options are also available:--author-name(optional)The name of the package author, e.g. ‘Jane Doe’.  Defaults to ‘[author-name]’.--author-email(optional)The email address of the author, e.g.‘jane.doe@inception-tools.org’.--org-name(optional)The name of the organization sponsoring development for the project, e.g.
‘inception-tools’.--archetype(optional)Determines the archetype used to create the stub project. Defaults to ‘cli’. Must be
one of the following:simpleCreates a basic project shell.cliCreates a project shell geared toward developing and publishing a
Python-based command-line application.libCreates a project shell geared specifically toward developing and
publishing a Python libraryLicenseinception-toolsis released under the Apache Software License v2.0 - see the filesLICENSEfor further details.Bugs, Contribution, and FeedbackContributions and feedback are welcome.  Contributions can be made by opening
a pull request at theinception-toolsrepositoryand tagging@avanherickfor
review.  Please see theDevelopmentsection of this document for code style
and branching guidelines.This project was created to fill what looked like a lack of standardized
conventions practices for structuring Python projects, and out of the desire
to avoid the need to manually create the same directory and file structures
over and over again.If you come across this project and know of other project which accomplish
similar goals, or of documented standards around Python project structure,
we would welcome hearing about them.Please submit feedback, bugs, feature requests, and code changes using GitHub
at:http://github.com/inception-tools/inception-toolsDevelopmentRepository Management:Inception Tools manages its repository using theGitFlowmodel.Code style:Inception Tools code should adhere to thePEP 8guidelines with the exception
of maximum line length, which instead usesblack’s default of 88.Versioning:Inception Tools uses semantic versioning and adheres to the guidelines
specifiedhere.CI/CD:All builds are automated through GitHub actions.Development builds are executed against thedevelopbranch.Beta builds are executed with each push to themasterbranch.Release builds are triggered by the creation of a release through GitHub.Changesv0.1.0Initial public versionauthor:Andrew van Herickemail:avanherick@gmail.comdate:2022-01-03