diff --git a/.github/README.md b/.github/README.md deleted file mode 100644 index e7eb479..0000000 --- a/.github/README.md +++ /dev/null @@ -1,314 +0,0 @@ -# Python First Library -[heading__top]: - #python-first-library - "⬆ Example library for use within other Python projects" - - -Example library for use within other Python projects - -## [![Byte size of Python First Library][badge__master__python_first_library__source_code]][python_first_library__master__source_code] [![Open Issues][badge__issues__python_first_library]][issues__python_first_library] [![Open Pull Requests][badge__pull_requests__python_first_library]][pull_requests__python_first_library] [![Latest commits][badge__commits__python_first_library__master]][commits__python_first_library__master] [![python-first-library Demos][badge__gh_pages__python_first_library]][gh_pages__python_first_library] - - ------- - - -- [:arrow_up: Top of Document][heading__top] - -- [:building_construction: Requirements][heading__requirements] - -- [:zap: Quick Start][heading__quick_start] - - - [🧰 Usage][heading__usage] - -- [🗒 Notes][heading__notes] - -- [:card_index: Attribution][heading__attribution] - -- [:balance_scale: Licensing][heading__license] - - ------- - - - -## Requirements -[heading__requirements]: - #requirements - "🏗 Prerequisites and/or dependencies that this project needs to function properly" - - -Python based developer dependencies may be installed via one of the following methods... - - -- Scoped within current user... - - -```Bash -pip3 install --user setuptools twine wheel -``` - - -- Scoped with a _Virtual Environment_ local to the directory of this project... - - -```Bash -pip3 install --user pipenv - -pipenv install setuptools twine wheel -``` - - -> Note, review [Python Guide -- `virtualenvs`](https://docs.python-guide.org/dev/virtualenvs/) for more information on Python Virtual Environments. - - -- Or scoped for the entire system... - - -```Bash -sudo pip3 install setuptools twine wheel -``` - - -> Note, generally installing dependencies system-wide is not recommended. - - -___ - - -## Quick Start -[heading__quick_start]: - #quick-start - "⚡ Perhaps as easy as one, 2.0,..." - - -Clone this project... - - -**Linux/MacOS** - - -```Bash -mkdir -vp ~/git/hub/development-tutorials - -cd ~/git/hub/development-tutorials - -git clone git@github.com:development-tutorials/python-first-library.git -``` - - -**Windows** - - -```Batch -set _organization_directory="%HOMEDRIVE%%HOMEPATH%\git\hub\development-tutorials" - -if not exists %_organization_directory ( - md %_organization_directory -) - -CD /D %_organization_directory - -git clone git@github.com:development-tutorials/python-first-library.git -``` - ------- - - -### Usage -[heading__usage]: - #usage - "🧰" - - -> Note the following are abbreviated instructions, check the [Tutorial][gh_pages__python_first_library] site for detailed guidance. - - -Example of packaging this project for publishing to Pip repository... - - -```Bash -python3 setup.py sdist bdist_wheel -``` - - -Example of uploading to the testing repository... - - -```Bash -twine upload --repository testpypi dist/python-first-library-0.0.1* -``` - - -Example of installing from testing repository... - - -```Bash -python3 -m pip install\ - --index-url https://test.pypi.org/simple/\ - --no-deps python-first-library- -``` - - -Example of inheriting and modifying a class from python-first-library... - - -```Python -#!/usr/bin/env python - - -from python_first_library import First_Library - - -class Customized_First_Library(First_Library): - """ - Customizes First_Library class with additional initialization parameters - """ - - def __init__(self, custom_arg = None, **kwargs): - """ - Adds `custom_arg` to initialization of parent First_Library class - """ - super(Customized_First_Library, self).__init__(**kwargs) - self.custom_arg = custom_arg - - def main(self, **kwargs): - """ - Prints `custom_arg` and returns results from parent `main()` method - """ - original_main_results = super(Customized_First_Library, self).main(**kwargs) - - print(original_main_results) - print("self.custom_arg -> {}".format(self.custom_arg)) - - return original_main_results - - -if __main__ == '__name__': - """ - Code that is run if this file is executed as a script instead of imported - """ - customized = Customized_First_Library(custom_arg = 'SPAM') - customized.main() -``` - - -___ - - -## Notes -[heading__notes]: - #notes - "🗒 Additional things to keep in mind when developing" - - -This repository may not be feature complete and/or fully functional, Pull Requests that add needed features and/or fix bugs are certainly welcomed. - -___ - - -## Attribution -[heading__attribution]: - #attribution - "📇 Resources that where helpful in building this project so far." - - -- [GitHub -- `github-utilities/make-readme`](https://github.com/github-utilities/make-readme) - -- [Python Packaging -- Packaging Projects](https://packaging.python.org/tutorials/packaging-projects/) - -- [Python Packaging -- Managing Dependencies](https://packaging.python.org/tutorials/managing-dependencies/) - -- [Python Packaging -- `install_requires` vs requirements files](https://packaging.python.org/discussions/install-requires-vs-requirements/) - -- [Python Packaging -- Classifiers](https://pypi.org/classifiers/) - -- [Python Packaging -- Packaging -- `MANIFEST.in`](https://packaging.python.org/guides/distributing-packages-using-setuptools/#manifest-in) - -- [Python Docs -- Writing the `setup.cfg` Configuration File](https://docs.python.org/3/distutils/configfile.html) - -- [setuptools -- Using `find_packages()`](https://setuptools.readthedocs.io/en/latest/setuptools.html#using-find-packages) - -- [Medium -- How to upload your Python package to PyPi](https://medium.com/@joel.barmettler/how-to-upload-your-python-package-to-pypi-65edc5fe9c56) - -- [StackOverflow -- Publishing modules to pip and PyPi](https://stackoverflow.com/questions/56129825/) - - -___ - - -## License -[heading__license]: - #license - "⚖ Legal side of Open Source" - - -``` -Example library for use within other Python projects -Copyright (C) 2020 S0AndS0 - -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU Affero General Public License as published -by the Free Software Foundation, version 3 of the License. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU Affero General Public License for more details. - -You should have received a copy of the GNU Affero General Public License -along with this program. If not, see . -``` - - -For further details review full length version of [AGPL-3.0][branch__current__license] License. - - - -[branch__current__license]: - /LICENSE - "⚖ Full length version of AGPL-3.0 License" - - -[badge__commits__python_first_library__master]: - https://img.shields.io/github/last-commit/development-tutorials/python-first-library/master.svg - -[commits__python_first_library__master]: - https://github.com/development-tutorials/python-first-library/commits/master - "📝 History of changes on this branch" - - -[python_first_library__community]: - https://github.com/development-tutorials/python-first-library/community - "🌱 Dedicated to functioning code" - -[python_first_library__gh_pages]: - https://github.com/development-tutorials/python-first-library/tree/ - "Source code examples hosted thanks to GitHub Pages!" - -[badge__gh_pages__python_first_library]: - https://img.shields.io/website/https/development-tutorials.github.io/python-first-library/index.html.svg?down_color=darkorange&down_message=Offline&label=Demo&logo=Demo%20Site&up_color=success&up_message=Online - -[gh_pages__python_first_library]: - https://development-tutorials.github.io/python-first-library/index.html - "🔬 Check the example collection tests" - -[issues__python_first_library]: - https://github.com/development-tutorials/python-first-library/issues - "☢ Search for and _bump_ existing issues or open new issues for project maintainer to address." - -[pull_requests__python_first_library]: - https://github.com/development-tutorials/python-first-library/pulls - "🏗 Pull Request friendly, though please check the Community guidelines" - -[python_first_library__master__source_code]: - https://github.com/development-tutorials/python-first-library/ - "⌨ Project source!" - -[badge__issues__python_first_library]: - https://img.shields.io/github/issues/development-tutorials/python-first-library.svg - -[badge__pull_requests__python_first_library]: - https://img.shields.io/github/issues-pr/development-tutorials/python-first-library.svg - -[badge__master__python_first_library__source_code]: - https://img.shields.io/github/repo-size/development-tutorials/python-first-library diff --git a/.gitignore b/.gitignore index 4cca050..484c15a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,8 +1,8 @@ -## Python compiled/cached -__pycache__ -*.pyc - -## Python setuptools -build -dist -python_first_library.egg-info +_site +.sass-cache +.jekyll-metadata +# Ignore files and folders generated by Bundler +Bundler +vendor +.bundle +node_modules diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..d5f1160 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,4 @@ +[submodule "includes-translate"] + path = _includes/modules/includes-translate + url = https://github.com/liquid-utilities/includes-translate.git + branch = master diff --git a/404.html b/404.html new file mode 100644 index 0000000..c472b4e --- /dev/null +++ b/404.html @@ -0,0 +1,24 @@ +--- +layout: default +--- + + + +
+

404

+ +

Page not found :(

+

The requested page could not be found.

+
diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..f19a9a4 --- /dev/null +++ b/Gemfile @@ -0,0 +1,32 @@ +source "https://rubygems.org" + +# Hello! This is where you manage which Jekyll version is used to run. +# When you want to use a different version, change it below, save the +# file and run `bundle install`. Run Jekyll with `bundle exec`, like so: +# +# bundle exec jekyll serve +# +# This will help ensure the proper Jekyll version is running. +# Happy Jekylling! +# gem "jekyll", "~> 3.8.5" +# This is the default theme for new Jekyll sites. You may change this to anything you like. +gem "minima", "~> 2.5" + +# If you want to use GitHub Pages, remove the "gem "jekyll"" above and +# uncomment the line below. To upgrade, run `bundle update github-pages`. +gem "github-pages", group: :jekyll_plugins + +# See - https://github.com/jekyll/github-metadata +# Adds site.github to Liquid building name space +gem "jekyll-github-metadata" + +# If you have any plugins, put them here! +group :jekyll_plugins do + gem "jekyll-feed", "~> 0.6" +end + +# Windows does not include zoneinfo files, so bundle the tzinfo-data gem +gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby] + +# Performance-booster for watching directories on Windows +gem "wdm", "~> 0.1.0" if Gem.win_platform? diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 0000000..11d7455 --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,250 @@ +GEM + remote: https://rubygems.org/ + specs: + activesupport (5.2.4.3) + concurrent-ruby (~> 1.0, >= 1.0.2) + i18n (>= 0.7, < 2) + minitest (~> 5.1) + tzinfo (~> 1.1) + addressable (2.7.0) + public_suffix (>= 2.0.2, < 5.0) + coffee-script (2.4.1) + coffee-script-source + execjs + coffee-script-source (1.11.1) + colorator (1.1.0) + commonmarker (0.17.13) + ruby-enum (~> 0.5) + concurrent-ruby (1.1.6) + dnsruby (1.61.3) + addressable (~> 2.5) + em-websocket (0.5.1) + eventmachine (>= 0.12.9) + http_parser.rb (~> 0.6.0) + ethon (0.12.0) + ffi (>= 1.3.0) + eventmachine (1.2.7) + execjs (2.7.0) + faraday (1.0.1) + multipart-post (>= 1.2, < 3) + ffi (1.12.2) + forwardable-extended (2.6.0) + gemoji (3.0.1) + github-pages (206) + github-pages-health-check (= 1.16.1) + jekyll (= 3.8.7) + jekyll-avatar (= 0.7.0) + jekyll-coffeescript (= 1.1.1) + jekyll-commonmark-ghpages (= 0.1.6) + jekyll-default-layout (= 0.1.4) + jekyll-feed (= 0.13.0) + jekyll-gist (= 1.5.0) + jekyll-github-metadata (= 2.13.0) + jekyll-mentions (= 1.5.1) + jekyll-optional-front-matter (= 0.3.2) + jekyll-paginate (= 1.1.0) + jekyll-readme-index (= 0.3.0) + jekyll-redirect-from (= 0.15.0) + jekyll-relative-links (= 0.6.1) + jekyll-remote-theme (= 0.4.1) + jekyll-sass-converter (= 1.5.2) + jekyll-seo-tag (= 2.6.1) + jekyll-sitemap (= 1.4.0) + jekyll-swiss (= 1.0.0) + jekyll-theme-architect (= 0.1.1) + jekyll-theme-cayman (= 0.1.1) + jekyll-theme-dinky (= 0.1.1) + jekyll-theme-hacker (= 0.1.1) + jekyll-theme-leap-day (= 0.1.1) + jekyll-theme-merlot (= 0.1.1) + jekyll-theme-midnight (= 0.1.1) + jekyll-theme-minimal (= 0.1.1) + jekyll-theme-modernist (= 0.1.1) + jekyll-theme-primer (= 0.5.4) + jekyll-theme-slate (= 0.1.1) + jekyll-theme-tactile (= 0.1.1) + jekyll-theme-time-machine (= 0.1.1) + jekyll-titles-from-headings (= 0.5.3) + jemoji (= 0.11.1) + kramdown (= 1.17.0) + liquid (= 4.0.3) + mercenary (~> 0.3) + minima (= 2.5.1) + nokogiri (>= 1.10.4, < 2.0) + rouge (= 3.19.0) + terminal-table (~> 1.4) + github-pages-health-check (1.16.1) + addressable (~> 2.3) + dnsruby (~> 1.60) + octokit (~> 4.0) + public_suffix (~> 3.0) + typhoeus (~> 1.3) + html-pipeline (2.13.0) + activesupport (>= 2) + nokogiri (>= 1.4) + http_parser.rb (0.6.0) + i18n (0.9.5) + concurrent-ruby (~> 1.0) + jekyll (3.8.7) + addressable (~> 2.4) + colorator (~> 1.0) + em-websocket (~> 0.5) + i18n (~> 0.7) + jekyll-sass-converter (~> 1.0) + jekyll-watch (~> 2.0) + kramdown (~> 1.14) + liquid (~> 4.0) + mercenary (~> 0.3.3) + pathutil (~> 0.9) + rouge (>= 1.7, < 4) + safe_yaml (~> 1.0) + jekyll-avatar (0.7.0) + jekyll (>= 3.0, < 5.0) + jekyll-coffeescript (1.1.1) + coffee-script (~> 2.2) + coffee-script-source (~> 1.11.1) + jekyll-commonmark (1.3.1) + commonmarker (~> 0.14) + jekyll (>= 3.7, < 5.0) + jekyll-commonmark-ghpages (0.1.6) + commonmarker (~> 0.17.6) + jekyll-commonmark (~> 1.2) + rouge (>= 2.0, < 4.0) + jekyll-default-layout (0.1.4) + jekyll (~> 3.0) + jekyll-feed (0.13.0) + jekyll (>= 3.7, < 5.0) + jekyll-gist (1.5.0) + octokit (~> 4.2) + jekyll-github-metadata (2.13.0) + jekyll (>= 3.4, < 5.0) + octokit (~> 4.0, != 4.4.0) + jekyll-mentions (1.5.1) + html-pipeline (~> 2.3) + jekyll (>= 3.7, < 5.0) + jekyll-optional-front-matter (0.3.2) + jekyll (>= 3.0, < 5.0) + jekyll-paginate (1.1.0) + jekyll-readme-index (0.3.0) + jekyll (>= 3.0, < 5.0) + jekyll-redirect-from (0.15.0) + jekyll (>= 3.3, < 5.0) + jekyll-relative-links (0.6.1) + jekyll (>= 3.3, < 5.0) + jekyll-remote-theme (0.4.1) + addressable (~> 2.0) + jekyll (>= 3.5, < 5.0) + rubyzip (>= 1.3.0) + jekyll-sass-converter (1.5.2) + sass (~> 3.4) + jekyll-seo-tag (2.6.1) + jekyll (>= 3.3, < 5.0) + jekyll-sitemap (1.4.0) + jekyll (>= 3.7, < 5.0) + jekyll-swiss (1.0.0) + jekyll-theme-architect (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-cayman (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-dinky (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-hacker (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-leap-day (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-merlot (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-midnight (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-minimal (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-modernist (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-primer (0.5.4) + jekyll (> 3.5, < 5.0) + jekyll-github-metadata (~> 2.9) + jekyll-seo-tag (~> 2.0) + jekyll-theme-slate (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-tactile (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-time-machine (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-titles-from-headings (0.5.3) + jekyll (>= 3.3, < 5.0) + jekyll-watch (2.2.1) + listen (~> 3.0) + jemoji (0.11.1) + gemoji (~> 3.0) + html-pipeline (~> 2.2) + jekyll (>= 3.0, < 5.0) + kramdown (1.17.0) + liquid (4.0.3) + listen (3.2.1) + rb-fsevent (~> 0.10, >= 0.10.3) + rb-inotify (~> 0.9, >= 0.9.10) + mercenary (0.3.6) + mini_portile2 (2.4.0) + minima (2.5.1) + jekyll (>= 3.5, < 5.0) + jekyll-feed (~> 0.9) + jekyll-seo-tag (~> 2.1) + minitest (5.14.1) + multipart-post (2.1.1) + nokogiri (1.10.9) + mini_portile2 (~> 2.4.0) + octokit (4.18.0) + faraday (>= 0.9) + sawyer (~> 0.8.0, >= 0.5.3) + pathutil (0.16.2) + forwardable-extended (~> 2.6) + public_suffix (3.1.1) + rb-fsevent (0.10.4) + rb-inotify (0.10.1) + ffi (~> 1.0) + rouge (3.19.0) + ruby-enum (0.8.0) + i18n + rubyzip (1.3.0) + safe_yaml (1.0.5) + sass (3.7.4) + sass-listen (~> 4.0.0) + sass-listen (4.0.0) + rb-fsevent (~> 0.9, >= 0.9.4) + rb-inotify (~> 0.9, >= 0.9.7) + sawyer (0.8.2) + addressable (>= 2.3.5) + faraday (> 0.8, < 2.0) + terminal-table (1.8.0) + unicode-display_width (~> 1.1, >= 1.1.1) + thread_safe (0.3.6) + typhoeus (1.4.0) + ethon (>= 0.9.0) + tzinfo (1.2.7) + thread_safe (~> 0.1) + unicode-display_width (1.7.0) + +PLATFORMS + ruby + +DEPENDENCIES + github-pages + jekyll-feed (~> 0.6) + jekyll-github-metadata + minima (~> 2.5) + tzinfo-data + +BUNDLED WITH + 1.17.3 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0ad25db --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/MANIFEST.in b/MANIFEST.in deleted file mode 100644 index 93c4136..0000000 --- a/MANIFEST.in +++ /dev/null @@ -1 +0,0 @@ -include .github/README.md diff --git a/_config.yml b/_config.yml new file mode 100644 index 0000000..04e7be2 --- /dev/null +++ b/_config.yml @@ -0,0 +1,51 @@ +# Welcome to Jekyll! +# +# This config file is meant for settings that affect your whole blog, values +# which you are expected to set up once and rarely edit after that. If you find +# yourself editing this file very often, consider using Jekyll's data files +# feature for the data you need to update frequently. +# +# For technical reasons, this file is *NOT* reloaded automatically when you use +# 'bundle exec jekyll serve'. If you change this file, please restart the server process. + +# Site settings +# These are used to personalize your new site. If you look in the HTML files, +# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on. +# You can create any custom variable you would like, and they will be accessible +# in the templates via {{ site.myvariable }}. +title: Python First Library +# email: your-email@example.com +description: >- # this means to ignore newlines until "baseurl:" + Tutorial for publishing Python libraries, and example library for use within + other Python projects. +baseurl: "python-first-library" # the subpath of your site, e.g. /blog +url: 'https://development-tutorials.github.io' +twitter_username: S0_And_S0 +author: S0AndS0 +github_username: development-tutorials + +post_order: reverse + +# Build settings +markdown: kramdown +theme: minima +show_excerpts: true +plugins: + - jekyll-feed + - jekyll-github-metadata + + +# Custom default for permalinks +permalink: /:title:output_ext + +# Exclude from processing. +# The following items will not be processed, by default. Create a custom list +# to override the default setting. +# exclude: +# - Gemfile +# - Gemfile.lock +# - node_modules +# - vendor/bundle/ +# - vendor/cache/ +# - vendor/gems/ +# - vendor/ruby/ diff --git a/_config_baseurl.yml b/_config_baseurl.yml new file mode 100644 index 0000000..dc2b472 --- /dev/null +++ b/_config_baseurl.yml @@ -0,0 +1,2 @@ +# Use base URL to simulate GitHub pages behavior +baseurl: "python-first-library" diff --git a/_includes/modules/includes-translate b/_includes/modules/includes-translate new file mode 160000 index 0000000..b0b0a68 --- /dev/null +++ b/_includes/modules/includes-translate @@ -0,0 +1 @@ +Subproject commit b0b0a68e2ec0fe50f44f8129b5a52dde1562ec3d diff --git a/_layouts/default.html b/_layouts/default.html new file mode 100644 index 0000000..f4a3e06 --- /dev/null +++ b/_layouts/default.html @@ -0,0 +1,24 @@ +--- +Source: https://raw.githubusercontent.com/jekyll/minima/v2.5.0/_layouts/default.html +License: MIT +Modified_For: liquid-utilities/includes-translate +--- + + + {%- include head.html -%} + + + {%- include header.html -%} + +
+
+ {% include modules/includes-translate/includes-translate.html %} + {{ content }} +
+
+ + {%- include footer.html -%} + + + + diff --git a/_layouts/home.html b/_layouts/home.html new file mode 100644 index 0000000..3c8314e --- /dev/null +++ b/_layouts/home.html @@ -0,0 +1,42 @@ +--- +layout: default +minima: + github_url: https://github.com/jekyll/minima + source_url: https://raw.githubusercontent.com/jekyll/minima/v2.5.0/_layouts/home.html + license: MIT +--- +
+ {%- if page.title -%} +

{{ page.title }}

+ {%- endif -%} + + {{ content }} + + {%- if site.posts.size > 0 -%} +

{{ page.list_title | default: "Posts" }}

+
    + {%- if site.post_order == 'reverse' -%} + {% assign posts = site.posts | reverse %} + {%- else -%} + {% assign posts = site.posts %} + {%- endif -%} + {%- for post in posts -%} +
  • + {%- assign date_format = site.minima.date_format | default: "%b %-d, %Y" -%} + {{ post.date | date: date_format }} +

    + + {{ post.title | escape }} + +

    + {%- if site.show_excerpts -%} + {{ post.excerpt }} + {%- endif -%} +
    • + {%- endfor -%} +
+ +

subscribe via RSS

+ {%- endif -%} + +
diff --git a/_posts/2020-05-31-register-pypi-accounts.md b/_posts/2020-05-31-register-pypi-accounts.md new file mode 100644 index 0000000..813e981 --- /dev/null +++ b/_posts/2020-05-31-register-pypi-accounts.md @@ -0,0 +1,69 @@ +--- +layout: post +title: "Register PyPi Accounts" +date: 2020-05-31 16:11:56 -0700 +categories: python library tutorial +excerpt: 'Links to testing and publishing repositories, and example `.pypirc` config. file' +--- + + + +## [#][heading__testing_repository] Testing Repository +[heading__testing_repository]: #-testing-repository "Python testing repository links" + + +- [`test.pypi.org` -- Register](https://test.pypi.org/account/register/) + +- [`test.pypi.org` -- API Token](https://test.pypi.org/manage/account/#api-tokens) + +- [`test.pypi.org` -- 2FA](https://pypi.org/manage/account/totp-provision) + + +Utilizing the testing repository is a good idea, because deleting and/or editing mistakes within the official publishing repository is not generally allowed. + + +Testing Repository installation syntax adds `--index-url https://test.pypi.org/simple/` and _`--no-deps -`_ options, eg... + + +```bash +python3 -m pip install\ + --index-url https://test.pypi.org/simple/\ + --no-deps python-first-library-S0AndS0 +``` + + +> Note, the `--no-deps` flag tells Pip to **not** install dependencies from the testing URL, this is important to avoid errors during installation, and testing. + + +------ + + +## [#][heading__publish_repository] Publish Repository +[heading__publish_repository]: #-publish-repository "Python publishing repository links" + + +- [`pypi.org` -- Register](https://pypi.org/account/register/) + +- [`pypi.org` -- API Token](https://pypi.org/manage/account/#api-tokens) + +- [`pypi.org` -- 2FA](https://pypi.org/manage/account/totp-provision) + + +Please do **not** skip setting up 2 Factor Authentication, because you'll be publishing code for others to make use of. + + +------ + + +## [#][heading__example_pypirc] Example `~/.pypirc` +[heading__example_pypirc]: #-example-~pypirc "Example pypirc configuraiton file" + + +``` +[pypi] + username = __token__ + ## Test + password = pypi-API_TEST_KEY... + ## Publish + # password = pypi-API_PUBLISH_KEY... +``` diff --git a/_posts/2020-06-01-setup-environment.md b/_posts/2020-06-01-setup-environment.md new file mode 100644 index 0000000..c464060 --- /dev/null +++ b/_posts/2020-06-01-setup-environment.md @@ -0,0 +1,29 @@ +--- +layout: post +title: "Setup Environment" +date: 2020-06-01 16:11:56 -0700 +categories: python library tutorial +excerpt: 'List of dependencies installed via Pip and links to relevant documentation' +--- + + + +Install `pip` by following [PyPa documentation](https://pip.pypa.io/en/stable/installing/) if `pip3 --version` returns an error. + + +Install Python environment dependencies to user account... + + +```bash +pip3 install --user setuptools twine wheel +``` + + +Documentation links for above dependencies; + + +- [Read The Docs -- `setuptools`](https://setuptools.readthedocs.io/en/latest/) _"Setuptools is a fully-featured, actively-maintained, and stable library designed to facilitate packaging Python projects..."_ + +- [Read The Docs -- `twine`](https://twine.readthedocs.io) _"Twine is a utility for publishing Python packages on PyPI."_ + +- [Read The Docs -- `wheel`](https://wheel.readthedocs.io) _"This library is the reference implementation of the Python wheel packaging standard, as defined in PEP 427."_ diff --git a/_posts/2020-06-02-initialize-project.md b/_posts/2020-06-02-initialize-project.md new file mode 100644 index 0000000..e027208 --- /dev/null +++ b/_posts/2020-06-02-initialize-project.md @@ -0,0 +1,89 @@ +--- +layout: post +title: "Initialize Project" +date: 2020-06-02 16:11:56 -0700 +categories: python library tutorial +excerpt: 'Instructions for setting up file and directory structure for new library' +--- + + + +Make directory path(s) to keep things organized... + + +```bash +mkdir -vp ~/git/hub/development-tutorials +``` + + +Initialize new Git repository... + + +```bash +git init ~/git/hub/development-tutorials/python-first-library +``` + + +> Note, throughout this tutorial the `python-first-library` repository directory should be replaced with the directory name for your library. + + +Change current working directory to your new project repository... + + +```bash +cd ~/git/hub/development-tutorials/python-first-library +``` + + +... add `hub` as a remote... + + +```bash +git remote add hub git@github.com:development-tutorials/python-first-library.git +``` + + +> Note, URL syntax is _`git@github.com:/.git`_ + + +... touch files for `setuptools` into existence... + + +```bash +touch .gitignore +touch MANIFEST.in +touch requirements.txt +touch setup.cfg +touch setup.py +``` + + +... finally make directory structure for project source code, and touch files for library and Command Line Interface example into existence... + + +```bash +mkdir -vp python_first_library/cli + + +touch python_first_library/__init__.py +touch python_first_library/cli/__init__.py +``` + + +## [#][heading__notes_about_files] Notes about files +[heading__notes_about_files]: #-notes-about-files "Quick descriptions list of what files are used for" + + +- `.gitignore` defines directory and file patterns that Git should ignore from version tracking + +- `MANIFEST.in` defines files not automatically detected by `setuptools` that need to be included within package archive + +- `requirements.txt` should define developer dependencies, note install dependencies will need to be defined within `setup.py` file + +- `setup.cfg` defines metadata about this project and may be used by code linters (code style enforcement tools) + +- `setup.py` is read/executed during installation process when _`pip install `_ is issued by users of this project + +- `python_first_library/__init__.py` will contain the main class(s) for this project that other projects should `import` + +- `python_first_library/cli/__init__.py` will contain fully functional example usage of project code as a command line application diff --git a/_posts/2020-06-03-make-readme.md b/_posts/2020-06-03-make-readme.md new file mode 100644 index 0000000..05481a6 --- /dev/null +++ b/_posts/2020-06-03-make-readme.md @@ -0,0 +1,203 @@ +--- +layout: post +title: "Make ReadMe" +date: 2020-06-03 16:11:56 -0700 +categories: python library tutorial +excerpt: "A project's ReadMe file is often the first documents users will review" +--- + + + +Change current working directory to your project repository... + + +```bash +cd ~/git/hub/development-tutorials/python-first-library +``` + + +## [#][Option One] Option One +[Option One]: #-option-one "Make a simple ReadMe file" + + +Make a simple ReadMe file... + + +```bash +cd ~/git/hub/development-tutorials/python-first-library + + +mkdir .github +touch .github/README.md +``` + + +Following is an example template that can be edited manually... + + +{% raw %} +```markdown +# Python First Library +[heading__top_of_document]: #python-first-library "Top of document" + + +------ + + +- [Python First Library][heading__top_of_document] + +- [Installation][heading__installation] + +- [Usage][heading__usage] + +- [Notes][heading__notes] + +- [Attribution][heading__attribution] + +- [License][heading__license] + + +------ + + +## Installation +[heading__installation]: #installation "How to install this project" + + +Install to user account via... + + + pip3 install --user python_first_library + + +## Usage +[heading__usage]: #usage "How to utilize this project" + + +Import within Python shell or script via... + + + from python_first_library import First_Library + + +## Notes +[heading__notes]: #notes "Things to keep in mind when using the project" + + + Anything else note worthy? + + +## Attribution +[heading__attribution]: #attribution "Resources that where helpful in building this project" + + +- [GitHub -- `development-tutorials/python-first-library`](https://github.com/development-tutorials/python-first-library) + + +## License +[heading__license]: #license "Legal side of Open Source software" + + +This project is released under the [AGPL version 3](/LICENSE) license + + +``` +{% endraw %} + + +------ + + +## [#][Option Two] Option Two +[Option Two]: #-option-two "Initialize ReadMe file via template" + + +The following examples make use of [GitHub -- `github-utilities/make-readme`](https://github.com/github-utilities/make-readme) project which builds ReadMe files from MustacheJS templates. + + +Initialize ReadMe file via template... + + +```bash +mkdir -vp ~/git/hub/github-utilities + +cd ~/git/hub/github-utilities + +git clone git@github.com:github-utilities/make-readme.git + +cd ~/git/hub/github-utilities/make-readme +``` + + +Install NPM dependencies... + + +```bash +npm install +``` + + +**Edit `github-utilities/make-readme` -- `dataView.json`** + + +```json +{ + "gfm": true, + "email": "account@host.tld", + "author": "S0AndS0", + "organization": "development-tutorials", + "repository": "python-first-library", + "output_directory": "~/git/hub/development-tutorials/python-first-library", + "description": "Example library for use within other Python projects", + "include_notes": true, + "include_shields_io": true, + "license": "AGPL-3.0", + "gh_pages": true, + "verbose": true, + "clobber": true, + "quick_start": { + "is_awk_script": false, + "is_github_action": false, + "is_node_package": false, + "is_python_package": true, + "is_submodule": false + }, + "requirements": { + "utilizes_awk": false, + "utilizes_npm": false, + "utilizes_github_actions": false, + "utilizes_pip": false, + "utilizes_submodules": false + }, + "files": [ + { + "in_path": ".mustache/.github/README.md.mst", + "out_path": ".github/README.md", + "partials": [ + ".mustache/partials/readme/quick_start/clone.md.mst", + ".mustache/partials/readme/quick_start/is_awk_script.md.mst", + ".mustache/partials/readme/quick_start/is_node_package.md.mst", + ".mustache/partials/readme/quick_start/is_github_action.md.mst", + ".mustache/partials/readme/quick_start/is_python_package.md.mst", + ".mustache/partials/readme/quick_start/is_submodule.md.mst", + ".mustache/partials/readme/requirements/utilizes_awk.md.mst", + ".mustache/partials/readme/requirements/utilizes_github_actions.md.mst", + ".mustache/partials/readme/requirements/utilizes_npm.md.mst", + ".mustache/partials/readme/requirements/utilizes_pip.md.mst", + ".mustache/partials/readme/requirements/utilizes_submodules.md.mst", + ".mustache/partials/readme/notes.md.mst" + ] + } + ] +} +``` + + +Make output directory for ReadMe file and generate new ReadMe file from template... + + +```bash +mkdir ~/git/hub/development-tutorials/python-first-library/.github + +npm run make-readme +``` diff --git a/_posts/2020-06-04-package-setup.md b/_posts/2020-06-04-package-setup.md new file mode 100644 index 0000000..e741151 --- /dev/null +++ b/_posts/2020-06-04-package-setup.md @@ -0,0 +1,118 @@ +--- +layout: post +title: "Package Setup" +date: 2020-06-04 16:11:56 -0700 +categories: python library tutorial +excerpt: 'Example `setup.py` script and related configuration files' +--- + + + +Change current working directory to your project repository... + + +```bash +cd ~/git/hub/development-tutorials/python-first-library +``` + + +------ + + +## [#][heading__manifest_in] `MANIFEST.in` +[heading__manifest_in]: #-manifestin "Defines paths that should be explicitly included or excluded" + + +The `MANIFEST.in` configuration file is where project files that are not automatically detected can either be included, or excluded, within build process... + + +``` +include .github/README.md +``` + + +... for this tutorial the ReadMe file is included, because by default `setuptools` will not include files within the `.github` directory. + + +------ + + +## [#][heading__setup_cfg] `setup.cfg` +[heading__setup_cfg]: #-setupcfg "Defines metadata and other project properties" + + +The `setup.cfg` configuration file is able to define much more than `metadata`, and the official [Python Docs -- Writing the `setup.cfg` Configuration File](https://docs.python.org/3/distutils/configfile.html) is worthy of review... + + +```cfg +[metadata] +description-file = .github/README.md +``` + + +... for this tutorial the the ReadMe file is defined as the `description-file` to notify web-based documentation scripts where to pull data from. + + +------ + + +## [#][heading__setup_py] `setup.py` +[heading__setup_py]: #-setuppy "Script that `pip install package-name` command calls" + + +The `setup.py` script is called by `setuptools` + + +```python +#!/usr/bin/env python3 + + +from setuptools import (find_packages, setup) + + +with open(".github/README.md", "r") as fh: + long_description = fh.read() + + +setup( + name = 'python_first_library', + version = '0.0.1', + author = '', + author_email = '@.', + description = 'An example Python library', + license = 'AGPL-3.0' + long_description = long_description, + long_description_content_type = 'text/markdown', + url = 'https://github.com/development-tutorials/python-first-library', + packages = find_packages(), + entry_points = { + 'console_scripts': [ + 'watch_path = python_first_library.cli:main' + ], + }, + install_requires = [], + classifiers = [ + 'Development Status :: 1 - Alpha', + 'Intended Audience :: Developers', + 'Topic :: Software Development', + 'Programming Language :: Python :: 3', + 'License :: OSI Approved :: GNU Affero General Public License v3', + 'Operating System :: POSIX :: Linux', + ], +) +``` + + +### [#][heading__notes_about_setup_py] Notes about `setup.py` +[heading__notes_about_setup_py]: #-notes-about-setuppy "Quick descriptions list of parameters for `setup` method" + + +- `name`, the name of your project this value is pre-pended within project archive files under the `dist/` directory +- `version`, tag and/or release version this value is inserted within project archive files under the `dist/` directory +- `author`, your account name +- `author_email`, a valid email address used to contact you +- `description`, short (less than 80 characters) description of your project +- `license`, the code/abbreviation for chosen license, the [OpenSource.org chart](https://opensource.org/licenses/category) lists most of the popular licenses with their abbreviations +- `url` HTTP URL to source code for your project +- `entry_points["console_scripts"]` list name of executable(s), import path, and function to call +- `classifiers`, check the [Python Packaging -- Classifiers](https://pypi.org/classifiers/) for complete listing of all valid options diff --git a/python_first_library/__init__.py b/_posts/2020-06-05-write-library.md similarity index 66% rename from python_first_library/__init__.py rename to _posts/2020-06-05-write-library.md index 90dc6a2..a4e7d72 100644 --- a/python_first_library/__init__.py +++ b/_posts/2020-06-05-write-library.md @@ -1,3 +1,29 @@ +--- +layout: post +title: "Write Library" +date: 2020-06-05 16:11:56 -0700 +categories: python library tutorial +excerpt: 'Example `First_Library` class' +--- + + + +Change current working directory to your project repository... + + +```bash +cd ~/git/hub/development-tutorials/python-first-library +``` + + +------ + + +## `python_first_library/__init__.py` +[python_first_library/__init__.py]: #python_first_library__init__py "" + + +```python #!/usr/bin/env python3 @@ -32,3 +58,7 @@ def __init__(self, **keyword_arguments): def print_keyword_arguments(self): print(self.keyword_arguments) +``` + + +When installed via pip, the class from this library will be importable via `from python_first_library import First_Library` diff --git a/python_first_library/cli/__init__.py b/_posts/2020-06-06-write-cli.md similarity index 72% rename from python_first_library/cli/__init__.py rename to _posts/2020-06-06-write-cli.md index 9766b62..f5327e5 100644 --- a/python_first_library/cli/__init__.py +++ b/_posts/2020-06-06-write-cli.md @@ -1,3 +1,29 @@ +--- +layout: post +title: "Write Command Line Interface" +date: 2020-06-06 16:11:56 -0700 +categories: python library tutorial +excerpt: 'Command Line Interface that shows how to utilize and test library' +--- + + + +Change current working directory to your project repository... + + +```bash +cd ~/git/hub/development-tutorials/python-first-library +``` + + +------ + + +## `python_first_library/cli/__init__.py` +[python_first_library/cli/__init__.py]: #python_first_librarycli__init__py "" + + +```python #!/usr/bin/env python3 @@ -64,3 +90,7 @@ def main(): exit(0) first_library.print_keyword_arguments() +``` + + +The `main` function is what is defined within the `console_scripts` parameter of the `setup.py` script, installation process will generally cross-link things correctly such that for MS devices a `.exe` file suffix is appended, or executable permissions are assigned for Unix devices. diff --git a/_posts/2020-06-07-tag-release-publish.md b/_posts/2020-06-07-tag-release-publish.md new file mode 100644 index 0000000..c69c8b3 --- /dev/null +++ b/_posts/2020-06-07-tag-release-publish.md @@ -0,0 +1,78 @@ +--- +layout: post +title: "Tag, Release, and Publish" +date: 2020-06-07 16:04:56 -0700 +categories: python library tutorial +excerpt: 'Steps that will repeat for publishing and updating the library' +--- + + + +Change current working directory to your project repository... + + +```bash +cd ~/git/hub/development-tutorials/python-first-library +``` + + +------ + + +Add and commit changes... + + +```bash +git add . + +git commit -m 'Adds source files for Python library' +``` + + +Tag last commit for release and push to GitHub... + + +```bash +git tag --annotate v0.0.1 -m ':bookmark: Initial RFC' + +git push hub master + +git push hub v0.0.1 +``` + + +Make a new release on GitHub (optional as of Python version 3 or greater)... + + +- Example: `https://github.com/development-tutorials/python-first-library/releases/new` + + +- Syntax: _`https://github.com///releases/new`_ + + +Publish to PyPi servers + + +```bash +python3 setup.py sdist bdist_wheel +``` + + +```bash +twine upload --repository testpypi dist/python-first-library-0.0.1* +# twine upload dist/python-first-library-0.0.1* +``` + + +> Note, there will be new directories and files generated by the build process... +> +> - `build/lib` directory, contains directories and files that will be packaged into an archive +> +> - `dist/` directory, contains archives that will be uploaded to PyPi servers +> +> . `python_first_library.egg-info/` directory, contains various metadata about the library +> +> ... these directories do **not** need to be tracked by Git, so it's generally okay to add patterns to the `.gitignore` file to ignore tracking them by default. + + +**Warning** if at any point files are removed from the library (eg. via `git rm path`), then file(s) will also need to be removed from the `build/lib` directory structure. diff --git a/about.md b/about.md new file mode 100644 index 0000000..c2796a2 --- /dev/null +++ b/about.md @@ -0,0 +1,61 @@ +--- +layout: page +title: About +permalink: /about/ +--- + + + +This site aims to provide detailed instructions and examples for publishing Python libraries. + + +To correct mistakes please [Fork](https://github.com/development-tutorials/python-first-library/fork), commit changes, and then open a [Pull Request](https://github.com/development-tutorials/python-first-library/pulls). Alternatively, to report bugs and/or offer suggestions please open an [Issue](https://github.com/development-tutorials/python-first-library/issues) if none already exists for a given topic. + + +Example source code is available within the `master` branch of this repository... + + +```bash +mkdir -vp ~/git/hub/development-tutorials + +cd ~/git/hub/development-tutorials + +git clone git@github.com:development-tutorials/python-first-library.git +cd python-first-library +git checkout master +``` + + +It is possible to install this example library from the `test.pypi.org` URL... + + +```bash +python3 -m pip install\ + --index-url https://test.pypi.org/simple/\ + --no-deps\ + python-first-library-S0AndS0 +``` + + +This is the base Jekyll theme, more info about customizing Jekyll themes, as well as basic Jekyll usage documentation are available at [jekyllrb.com](https://jekyllrb.com/) + +Source code for Minima is available at GitHub: [jekyll][jekyll-organization] / [minima](https://github.com/jekyll/minima) + +Source code for Jekyll is available at GitHub: [jekyll][jekyll-organization] / [jekyll](https://github.com/jekyll/jekyll) + + +This site's source is available within the `gh-pages` branch of this repository... + + +```bash +cd ~/git/hub/development-tutorials/python-first-library + +git checkout gh-pages +``` + + +Resources used to build this tutorial are listed within the ReadMe file for this project under the [Attribution](https://github.com/development-tutorials/python-first-library#attribution) section. + + + +[jekyll-organization]: https://github.com/jekyll diff --git a/index.md b/index.md new file mode 100644 index 0000000..be2378f --- /dev/null +++ b/index.md @@ -0,0 +1,49 @@ +--- +layout: home +list_title: Steps +--- + + + +**Warning** this tutorial is a draft, and until this warning is removed pages/posts may move! In other-words. please avoid bookmarking individual posts until this warning is removed. To correct any inaccuracies [Pull Requests](https://github.com/development-tutorials/python-first-library) are very welcomed. + + +___ + + +This tutorial is intended for those that wish to publish a library or libraries to Python Pip repository. Before following this guide, readers should have Python installed, as well as some knowledge of reading and writing Python code. The official [getting started](https://www.python.org/about/gettingstarted/) documentation from Python, is an excellent resource if statring out or if refreshing one's knowledge feels needed. + + +Python Language source may be downloaded from [`python.org`](https://www.python.org/downloads/) for most Operating Systems, alternatively most Linux distributions have python available via package manager... + + +```bash +## Arch inspired distributions +sudo packman -S python3 python3-pip + +## Debian derived distributions +sudo apt-get install python3 python3-pip +``` + + +Most, if not all, of the command-line examples will be for a Bash (Born Again SHell) environment, eg... + + +- _`cd ~/somewhere`_ -- _`c`hange `d`irectory_ to _`somewhere`_ under the current user's home (_`~`_) directory + +- _`mkdir ~/somewhere/another-thing`_ -- _`m`a`k`e `dir`ectory_ under the current user's home (_`~`_) directory with the path of _`somewhere/another-thing`_ + +- _`touch ~/somewhere/another-thing/file.ext`_ -- update last modified time, or create an empty file, named _`file.ext`_ under the current user's home (_`~`_) directory with a directory path of _`somewhere/another-thing`_ + +- Long command-line examples are split using a backslash (`\`) to escape new-lines, and lines that follow are indented by two spaces (` `)... + + +```bash +executable-name --param-one "first modifier"\ + --param-two "second modifier"\ + --flag-one\ + --flag-two +``` + + +As much as possible, commands specific to Bash will be limited to above examples. Commands for Git and Python code examples _should_ otherwise be environment agnostic so long as your device has applications and dependencies installed. diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index 00b8296..0000000 --- a/setup.cfg +++ /dev/null @@ -1,2 +0,0 @@ -[metadata] -description-file = .github/README.md diff --git a/setup.py b/setup.py deleted file mode 100644 index 9a155c5..0000000 --- a/setup.py +++ /dev/null @@ -1,36 +0,0 @@ -#!/usr/bin/env python3 - - -from setuptools import (find_packages, setup) - - -with open(".github/README.md", "r") as fh: - long_description = fh.read() - - -setup( - name = 'python_first_library', - version = '0.0.1', - author = 'S0AndS0', - author_email = 'StrangerThanBland@gmail.com', - description = 'An example Python library', - license = 'AGPL-3.0', - long_description = long_description, - long_description_content_type = 'text/markdown', - url = 'https://github.com/development-tutorials/python-first-library', - packages = find_packages(), - entry_points = { - 'console_scripts': [ - 'watch_path = python_first_library.cli:main' - ], - }, - install_requires = [], - classifiers = [ - 'Development Status :: 1 - Alpha', - 'Intended Audience :: Developers', - 'Topic :: Software Development', - 'Programming Language :: Python :: 3', - 'License :: OSI Approved :: GNU Affero General Public License v3', - 'Operating System :: POSIX :: Linux', - ], -)