diff --git a/.coveragerc b/.coveragerc new file mode 100644 index 0000000..013dd20 --- /dev/null +++ b/.coveragerc @@ -0,0 +1,2 @@ +[report] +show_missing = True diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml new file mode 100644 index 0000000..e69122c --- /dev/null +++ b/.github/workflows/publish-docs.yml @@ -0,0 +1,32 @@ +# This workflow builds and publishes the latest docs to +# the `gh-pages` branch. +# For more details: https://github.com/marketplace/actions/deploy-to-github-pages +name: Publish docs + +on: + release: + types: [created] + workflow_dispatch: + +jobs: + build-and-deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + with: + # fetch all tags so `versioneer` can properly determine current version + fetch-depth: 0 + - name: Set up Python + uses: actions/setup-python@v2 + with: + python-version: '3.8' + - name: Install dependencies + run: python -m pip install -r requirements.txt .[dev] + - name: Build + run: make sphinx + shell: bash + - name: Publish + uses: JamesIves/github-pages-deploy-action@4.0.0 + with: + branch: gh-pages + folder: docs/_build/html \ No newline at end of file diff --git a/.github/workflows/publish-package.yml b/.github/workflows/publish-package.yml new file mode 100644 index 0000000..49d5e2f --- /dev/null +++ b/.github/workflows/publish-package.yml @@ -0,0 +1,31 @@ +# This workflow publishes the package to pypi. +# For more details: +# https://docs.github.com/en/actions/guides/building-and-testing-python#publishing-to-package-registries +name: Publish + +on: + release: + types: [created] + +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + with: + # fetch all tags so `versioneer` can properly determine current version + fetch-depth: 0 + - name: Set up Python + uses: actions/setup-python@v2 + with: + python-version: '3.8' + - name: Install dependencies + run: python -m pip install -r requirements.txt .[dev] + - name: Build and publish + env: + TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }} + TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }} + TWINE_REPOSITORY: pypi + run: | + python -m build --wheel + twine upload dist/* \ No newline at end of file diff --git a/.github/workflows/test-package.yml b/.github/workflows/test-package.yml new file mode 100644 index 0000000..5bfe2ed --- /dev/null +++ b/.github/workflows/test-package.yml @@ -0,0 +1,35 @@ +# Install and test +name: Python package +on: + push: + branches: + - dev + - main + pull_request: + branches: + - dev + - main +jobs: + build: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: + - 3.7 + - 3.8 + steps: + - uses: actions/checkout@v2 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v2 + with: + python-version: ${{ matrix.python-version }} + - name: Install dependencies + run: python -m pip install -r requirements.txt .[dev] + - name: Check docstrings + run: python -m pydocstyle edgetest_pip_tools --convention=numpy + - name: Check static typing + run: python -m mypy edgetest_pip_tools + - name: Run flake8 + run: python -m flake8 edgetest_pip_tools + - name: Run unit testing + run: python -m pytest tests --cov=edgetest_pip_tools --cov-fail-under=80 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..87e7ce4 --- /dev/null +++ b/.gitignore @@ -0,0 +1,110 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +.hypothesis/ +.pytest_cache/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ +docs/source/api/ +docs/source/auto_examples/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# pyenv +.python-version + +# celery beat schedule file +celerybeat-schedule + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ + +.DS_Store +.idea/ +pip-wheel-metadata/ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..535a91a --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,29 @@ +exclude: ^notebooks/ +repos: + - repo: https://github.com/psf/black + rev: 20.8b1 + hooks: + - id: black + types: [file, python] + language_version: python3.7 + - repo: https://github.com/pre-commit/mirrors-isort + rev: v5.5.4 + hooks: + - id: isort + - repo: https://github.com/pycqa/flake8 + rev: 3.8.3 + hooks: + - id: flake8 + additional_dependencies: [flake8-docstrings] + files: ^edgetest_pip_tools/ + language_version: python3.7 + - repo: https://github.com/jazzband/pip-tools + rev: 5.5.0 + hooks: + - id: pip-compile + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v3.2.0 + hooks: + - id: trailing-whitespace + - id: debug-statements + - id: end-of-file-fixer diff --git a/AUTHORS.md b/AUTHORS.md new file mode 100644 index 0000000..8452c35 --- /dev/null +++ b/AUTHORS.md @@ -0,0 +1,5 @@ +# Contributors + +List any contributors here! + +- Akshay Gupta \ No newline at end of file diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 0000000..57fdb9c --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1 @@ +* @fdosani @ak-gupta \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..8d8b825 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,4 @@ +include *.ini +include *.md +include *.txt +include *.toml diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..e925553 --- /dev/null +++ b/Makefile @@ -0,0 +1,16 @@ +coverage: + pytest --verbose --cov=edgetest-pip-tools + +sphinx: + cd docs && \ + make -f Makefile clean && \ + make -f Makefile html && \ + cd .. + +ghpages: + git checkout gh-pages && \ + cp -r docs/_build/html/* . && \ + touch .nojekyll && \ + git add -u && \ + git add -A && \ + PRE_COMMIT_ALLOW_NO_CONFIG=1 git commit -m "Updated generated Sphinx documentation" diff --git a/README.md b/README.md new file mode 100644 index 0000000..0a4183a --- /dev/null +++ b/README.md @@ -0,0 +1,55 @@ +# pip-tools integration for edgetest + +![python-3.7](https://img.shields.io/badge/python-3.7-green.svg) +[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black) + +[Full Documentation](https://capitalone.github.io/edgetest-pip-tools/) + +Table Of Contents +----------------- + +- [Install](#install) +- [Getting Started](#getting-started) +- [Options](#options) +- [Examples](#examples) +- [Contributing](#contributing) +- [License](#license) + +Install +------- + +Installation from PyPI: + +```console +$ python -m pip install edgetest-pip-tools +``` + +Getting Started +--------------- + +This `edgetest` plugin runs after the test execution. If the last environment successfully +passes, this plugin will refresh `requirements.txt` using `pip-tools`. To use this plugin, +you must use the ``--export`` flag in your CLI call: + +```console +$ edgetest --config setup.cfg --export +``` + +If you want to specify a PyPI index supply `index_url` in your configuration: + +```ini +[edgetest.pip_tools] +index_url = ... +``` + +If you want to include extra installations in your `pip-tools` call (only available for PEP-517 +compliant builds), add a newline-separated list of extras: + +```ini +[edgetest.pip_tools] +extras = + complete +``` + +Contributing +------------ diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..8324015 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,28 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SPHINXPROJ = edgetest-pip-tools +SOURCEDIR = source +BUILDDIR = _build +SPHINXAPI = sphinx-apidoc + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: html help Makefile + +html: apidoc + $(SPHINXBUILD) -b html $(SPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html + +apidoc: + $(SPHINXAPI) -E -f -o source/api ../edgetest_pip_tools + @echo "Regenerated API docs in ./source/api" + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..f3d5f0a --- /dev/null +++ b/docs/index.html @@ -0,0 +1,15 @@ + + + + + + + Page Redirection + + + + If you are not redirected automatically, follow the link here. + + diff --git a/docs/source/_static/placeholder b/docs/source/_static/placeholder new file mode 100644 index 0000000..e69de29 diff --git a/docs/source/_templates/placeholder b/docs/source/_templates/placeholder new file mode 100644 index 0000000..e69de29 diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..7ff2fec --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,185 @@ +# -*- coding: utf-8 -*- +# +# Configuration file for the Sphinx documentation builder. +# +# This file does only contain a selection of the most common options. For a +# full list see the documentation: +# http://www.sphinx-doc.org/en/master/config + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys + +sys.path.insert(0, os.path.abspath("../..")) + + +# -- Project information ----------------------------------------------------- + +project = "pip-tools integration for edgetest" +copyright = "2021, Akshay Gupta" +author = "Akshay Gupta" + +# The short X.Y version +version = "2021.11.0" +# The full version, including alpha/beta/rc tags +release = "" + + +# -- General configuration --------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.doctest", + "sphinx.ext.todo", + "sphinx.ext.coverage", + "sphinx.ext.imgmath", + "sphinx.ext.viewcode", + "sphinx.ext.githubpages", + "sphinx.ext.napoleon", + "sphinx_tabs.tabs", + "sphinx_copybutton", +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = ".rst" + +# The master toctree document. +master_doc = "index" + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path . +exclude_patterns = [] + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = "furo" + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +html_theme_options = {} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ["_static"] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# The default sidebars (for documents that don't match any pattern) are +# defined by theme itself. Builtin themes are using these templates by +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', +# 'searchbox.html']``. +# +# This is required for the alabaster theme +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars +html_sidebars = {} + + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = "edgetest-pip-toolsdoc" + + +# -- Options for LaTeX output ------------------------------------------------ + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ( + master_doc, + "edgetest-pip-tools.tex", + "pip-tools integration for edgetest Documentation", + "Akshay Gupta", + "manual", + ), +] + + +# -- Options for manual page output ------------------------------------------ + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ( + master_doc, + "edgetest-pip-tools", + "pip-tools integration for edgetest Documentation", + [author], + 1, + ) +] + + +# -- Options for Texinfo output ---------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ( + master_doc, + "edgetest-pip-tools", + "pip-tools integration for edgetest Documentation", + author, + "pip-tools integration for edgetest", + "One line description of project.", + "Miscellaneous", + ), +] + + +# -- Extension configuration ------------------------------------------------- + +# -- Options for todo extension ---------------------------------------------- + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True diff --git a/docs/source/developer.rst b/docs/source/developer.rst new file mode 100644 index 0000000..b4b14ef --- /dev/null +++ b/docs/source/developer.rst @@ -0,0 +1,39 @@ +Developer instructions +====================== + +Guidance for conda edgetest plugin developers + +Pre-Config and Black +-------------------- + +For developers, Bleeding edge dependency testing uses `pre-commit `_ to run the +`black `_ code formatter before each commit. In a nutshell what happens is: + + +* You edit some code locally, then ``git add`` and ``git commit`` +* As the commit is registered by ``git``\ , the ``pre-commit`` package runs ``black`` on any changed files + in the commit. (You can also run ``pre-commit run --all-files`` to run on all files) and will show + as having *failed* if it has made any edits. If ``black`` has made edits to the edited files, you + need to re-add and re-commit those specific files. +* Then you can ``git push`` to your hearts' content! +* The ``black`` code formatter forces our hand on code formatting and style - that means that all of + the code follows the same style, and we can focus on the meat of the issue. + +The first time you clone Bleeding edge dependency testing into a new environment, you need to run ``pre-commit install`` after +pip/conda installation. You do *not* need pre-commit to just run Bleeding edge dependency testing. If you have a pre-existing +environment, go ahead and ``pip install pre-commit`` and you should be fine. Generally, +only PRs with black styling will be accepted by the Bleeding edge dependency testing team. + +Contribution guidelines +----------------------- + +Keep an eye on the `issues `_. +We are always happy for help, including such things as: + +- Bug reports +- Feature requests +- Commenting on issues ("me too!" and "+1" can be helpful) +- Positive feedback (It's always lovely to hear!) +- Negative feedback (but be nice) +- Pull Requests to fix a bug +- Pull Requests to implement a feature (though we wouldn't mind discussing first) diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..5956603 --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,33 @@ +.. pip-tools integration for edgetest documentation master file, created by + sphinx-quickstart on Thu Jun 14 15:26:36 2018. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to the ``edgetest-pip-tools`` documentation! +==================================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + quickstart + developer + release_guide + + + +.. toctree:: + :maxdepth: 4 + :caption: API Reference + + api/modules + Github Repo + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst new file mode 100644 index 0000000..f4b62c1 --- /dev/null +++ b/docs/source/quickstart.rst @@ -0,0 +1,42 @@ +Quick Start +=========== + +Install +------- + +Installation from PyPI: + +.. code-block:: console + + $ python -m pip install edgetest-pip-tools + +Getting Started +--------------- + +This `edgetest` plugin runs after the test execution. If the last environment successfully +passes, this plugin will refresh `requirements.txt` using `pip-tools`. To use this plugin, +supply ``--export`` to your CLI call: + +.. code-block:: console + + $ edgetest --config setup.cfg --export + +If you want to specify a PyPI index, supply `index_url` in your configuration: + +.. code-block:: ini + + [edgetest.pip_tools] + index_url = ... + +If you want to include extra installations in your `pip-tools` call add a newline-separated list of +extras: + +.. code-block:: ini + + [edgetest.pip_tools] + extras = + complete + +.. important:: + + Extra installations are only available with PEP-517 compliant installations. diff --git a/docs/source/release_guide.rst b/docs/source/release_guide.rst new file mode 100644 index 0000000..71b3a3c --- /dev/null +++ b/docs/source/release_guide.rst @@ -0,0 +1,47 @@ +Release Guide +============= + +Overview +-------- + +As part of the on going maintenance of the project having a standardized release +procedure for our repos is key. We follows as pared down version of git-flow +which can be read in more detail `here. `_ +We use ``bumpver`` to automate calendar versioning. To run ``bumpver`` and update +your branch in preparation for an upcoming release, run ``bumpver update``. This +will update all necessary files and commit them using ``git``. + +``dev`` is the default branch where most people will work with day to day. +All features must be squash merged into this branch. The reason we squash merge +is to prevent the dev branch from being polluted with endless commit messages +when people are developing. Squashing collapses all the commits into one single +new commit. It will also make it much easier to back out changes if something breaks. + +``main`` is where official releases will go. Each release on ``main`` should +be tagged properly to denote a "version" that will have the corresponding artifact +on PyPI for users to ``pip install``. + + +``gh-pages`` is where official documentation will go. After each release you should +build the docs and push the HTML to the pages branch. When first setting up the +repo you want to make sure your gh-pages is a orphaned branch since it is +disconnected and independent from the code: ``git checkout --orphan gh-pages``. + +To build the documentation, run ``make sphinx``. To push, run ``make ghpages``. + + +TLDR; +----- + +* Each feature should have its own branch. +* Each feature branch should be squash merged into ``dev`` +* Before a release, bump the version using ``bumpver``. +* Merge ``dev`` into ``main`` via a regular "merge commits" +* Build and push docs ``gh-pages``. +* Build and push version to PyPI. + + +.. note:: + + ``main``, ``dev``, and ``gh-pages`` should be protected in the GitHub UI + so they aren't accidentally deleted. diff --git a/edgetest_pip_tools/__init__.py b/edgetest_pip_tools/__init__.py index 9886c41..d609b77 100644 --- a/edgetest_pip_tools/__init__.py +++ b/edgetest_pip_tools/__init__.py @@ -4,7 +4,7 @@ __title__ = "edgetest-pip-tools" __description__ = "pip-tools integration for edgetest" -__url__ = "https://github.capitalone.com/capitalone/edgetest-pip-tools" +__url__ = "https://github.com/capitalone/edgetest-pip-tools" __uri__ = __url__ __doc__ = __description__ + " <" + __uri__ + ">" diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..ac67e54 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,45 @@ +# +# This file is autogenerated by pip-compile with python 3.7 +# To update, run: +# +# pip-compile setup.cfg +# + +cerberus==1.3.3 + # via edgetest +click==7.1.2 + # via + # edgetest + # pip-tools +edgetest==2021.11.0 + # via edgetest-pip-tools (setup.cfg) +importlib-metadata==4.8.2 + # via + # pep517 + # pluggy +packaging==20.9 + # via edgetest +pep517==0.12.0 + # via pip-tools +pip-tools==6.4.0 + # via edgetest-pip-tools (setup.cfg) +pluggy==1.0.0 + # via edgetest +pyparsing==3.0.6 + # via packaging +rstgen==21.3.0 + # via edgetest +tomli==1.2.2 + # via pep517 +typing-extensions==4.0.0 + # via importlib-metadata +wheel==0.37.0 + # via pip-tools +zipp==3.6.0 + # via + # importlib-metadata + # pep517 + +# The following packages are considered to be unsafe in a requirements file: +# pip +# setuptools diff --git a/setup.cfg b/setup.cfg index 43ba8ac..1ee2b00 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,13 +1,14 @@ [metadata] name = edgetest-pip-tools version = attr: edgetest_pip_tools.__version__ -description = attr: edgetest_pip_tools.__description__ +description = pip-tools integration for edgetest long_description = file: README.md, MAINTAINERS -author = attr: edgetest_pip_tools.__author__ -author_email = attr: edgetest_pip_tools.__email__ -maintainer = attr: edgetest_pip_tools.__author__ -maintainer_email = attr: edgetest_pip_tools.__email__ -url = attr: edgetest_pip_tools.__url__ +long_description_content_type = text/markdown +author = Akshay Gupta +author_email = akshay.gupta2@capitalone.com +maintainer = Akshay Gupta +maintainer_email = akshay.gupta2@capitalone.com +url = https://github.com/capitalone/edgetest-pip-tools python_requires = >=3.7.0 project_urls = @@ -15,11 +16,14 @@ project_urls = Bug Tracker = https://github.com/capitalone/edgetest-pip-tools/issues Source Code = https://github.com/capitalone/edgetest-pip-tools classifiers = - Intended Audience :: Everyone + Intended Audience :: Developers Natural Language :: English Operating System :: OS Independent Programming Language :: Python + Programming Language :: Python :: 3 + Programming Language :: Python :: 3 :: Only Programming Language :: Python :: 3.7 + Programming Language :: Python :: 3.8 [options] zip_safe = False @@ -27,7 +31,7 @@ include_package_data = True packages = find: install_requires = edgetest - pip-tools>=6.0.0,<=6.2.0 + pip-tools>=6.0.0,<=6.4.0 [options.extras_require] docs = @@ -42,7 +46,6 @@ tests = pydocstyle pytest pytest-cov - tox-conda qa = black isort @@ -51,7 +54,9 @@ qa = pylint types-click build = + build twine + wheel dev = %(tests)s %(docs)s