TheLanguage1 0.2.0

Description:

TheLanguage1 0.2.0

TheLanguage1







TheLanguage1
Initial implementation of "TheLanguage".
Overview
TODO: Complete this section
How to use TheLanguage1
TODO: Complete this section
Installation via Executable
Download an executable for Linux, MacOS, or Windows to use the functionality provided by this repository without a dependency on Python.

Download the archive for the latest release here; the files will begin with exe. and contain the name of your operating system.
Decompress the archive

Installation via pip
Install the TheLanguage1 package via pip (Package Installer for Python) to use it with your python code.
pip install TheLanguage1
Local Development
Follow these steps to prepare the repository for local development activities.


Clone this repository


Bootstrap the local repository by running...



Operating System
Command




Linux / MacOS
Standard:Bootstrap.shStandard + packaging:Bootstrap.sh --package


Windows
Standard:Bootstrap.cmdStandard + packaging:Bootstrap.cmd --package





Activate the development environment by running...



Operating System
Command




Linux / MacOS
. ./Activate.sh


Windows
Activate.cmd





Invoke Build.py



Command
Description
Example
Notes




black
Validates that the source code is formatted by black.
Validation:python Build.py blackPerform formatting:python Build.py black --format



pylint
Validates the source code using pylint.
python Build.py pylint



pytest
Runs automated tests using pytest.
Without Code Coverage:python Build.py pytestWith Code Coverage:python Build.py pytest --code-coverage



update_version
Updates the semantic version of the package based on git commits using AutoGitSemVer.
python Build.py update_version



package
Creates a Python wheel package for distribution; outputs to the /dist directory.
python Build.py package
Requires --package when bootstrapping in step #2.


publish
Publishes a Python wheel package to PyPi.
https://test.pypi.org:python Build.py publishhttps://pypi.org:python Build.py publish --production
Requires --package when bootstrapping in step #2.


build_binary
Builds an executable for your package that can be run on machines without a python installation; outputs to the /build directory.
python Build.py build_binary
Requires --package when bootstrapping in step #2.





[Optional] Deactivate the development environment by running...



Operating System
Command




Linux / MacOS
. ./Deactivate.sh


Windows
Deactivate.cmd





License
TheLanguage1 is licensed under the MIT license.