tox-envfile 0.0.4__tar.gz → 0.0.6__tar.gz

{tox-envfile-0.0.4 → tox_envfile-0.0.6}/.cookiecutter/cookiecutter.json

@@ -1,13 +1,16 @@
 {
   "template": "https://github.com/hypothesis/cookiecutters",
   "directory": "pypackage",
-  "ignore": ["INSTALL.md"],
+  "ignore": [
+    "src/tox_envfile/core.py",
+    "tests/unit/tox_envfile/core_test.py"
+  ],
   "extra_context": {
     "name": "tox-envfile",
     "package_name": "tox_envfile",
     "slug": "tox-envfile",
     "short_description": "Load env files in your tox envs.",
-    "python_versions": "3.10.4, 3.9.12, 3.8.13",
+    "python_versions": "3.12.4, 3.11.9, 3.10.14, 3.9.19, 3.8.19",
     "github_owner": "hypothesis",
     "copyright_holder": "Hypothesis",
     "public": "yes",
@@ -15,6 +18,8 @@
     "dependabot_pip_interval": "monthly",
     "__entry_point": "tox-envfile",
     "__github_url": "https://github.com/hypothesis/tox-envfile",
-    "__pypi_url": "https://pypi.org/project/tox-envfile"
+    "__pypi_url": "https://pypi.org/project/tox-envfile",
+    "__copyright_year": "2022",
+    "pypi": "yes"
   }
 }

tox-envfile-0.0.4/.cookiecutter/includes/README.md → tox_envfile-0.0.6/.cookiecutter/includes/README/head.md

@@ -1,4 +1,3 @@
-
 tox-envfile reads environment variables from a file named `.devdata.env` in the
 same directory as your `tox.ini` file and adds them to the environment that tox
 runs your commands in.

tox_envfile-0.0.6/.cookiecutter/includes/README/tail.md

@@ -0,0 +1,39 @@
+Testing Manually
+----------------
+
+To test it manually you can install your local development copy of
+`tox-envfile` into the local development environment of another tox-using
+project such as
+[cookiecutter-pypackage-test](https://github.com/hypothesis/cookiecutter-pypackage-test):
+
+1. Install a local development copy of `cookiecutter-pypackage-test` in a temporary directory:
+
+   ```terminal
+   git clone https://github.com/hypothesis/cookiecutter-pypackage-test.git /tmp/cookiecutter-pypackage-test
+   ```
+
+2. Run `cookiecutter-pypackage-test`'s `make sure` command to make sure that
+   everything is working and to trigger tox to create its `.tox/.tox`
+   venv:
+
+   ```terminal
+   make --directory "/tmp/cookiecutter-pypackage-test" sure
+   ```
+
+3. Uninstall the production copy of `tox-envfile` from `cookiecutter-pypackage-test`'s `.tox/.tox` venv:
+
+   ```terminal
+   /tmp/cookiecutter-pypackage-test/.tox/.tox/bin/pip uninstall tox-envfile
+   ```
+
+4. Install your local development copy of `tox-envfile` into `cookiecutter-pypackage-test`'s `.tox/.tox` venv:
+
+   ```terminal
+   /tmp/cookiecutter-pypackage-test/.tox/.tox/bin/pip install -e .
+   ```
+
+5. Now `cookiecutter-pypackage-test` commands will use your local development copy of `tox-envfile`:
+
+   ```terminal
+   make --directory "/tmp/cookiecutter-pypackage-test" test
+   ```

{tox-envfile-0.0.4 → tox_envfile-0.0.6}/.github/workflows/ci.yml

@@ -1,7 +1,17 @@
 name: CI
 on:
   push:
+    paths-ignore:
+      - '.cookiecutter/*'
+      - '.github/dependabot.yml'
+      - 'bin/make_python'
+      - 'bin/make_template'
+      - 'docs/*'
+      - '**/.gitignore'
+      - 'LICENSE'
+      - '*.md'
   workflow_dispatch:
+  workflow_call:
   schedule:
   - cron: '0 1 * * *'
 jobs:
@@ -12,8 +22,8 @@ jobs:
       - name: Install Python
         uses: actions/setup-python@v4
         with:
-          python-version: '3.10'
-      - run: python -m pip install tox
+          python-version: '3.12'
+      - run: python -m pip install 'tox<4'
       - run: tox -e checkformatting
   Lint:
     runs-on: ubuntu-latest
@@ -22,14 +32,24 @@ jobs:
       - name: Install Python
         uses: actions/setup-python@v4
         with:
-          python-version: '3.10'
-      - run: python -m pip install tox
+          python-version: '3.12'
+      - run: python -m pip install 'tox<4'
       - run: tox -e lint
+  Typecheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.12'
+      - run: python -m pip install 'tox<4'
+      - run: tox -e typecheck
   Tests:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.10', '3.9', '3.8']
+        python-version: ['3.12', '3.11', '3.10', '3.9', '3.8']
     name: Unit tests with Python ${{ matrix.python-version }}
     steps:
       - uses: actions/checkout@v3
@@ -37,8 +57,10 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
-      - run: python -m pip install tox
+      - run: python -m pip install 'tox<4'
       - run: tox -e tests
+        env:
+          COVERAGE_FILE: .coverage.${{ matrix.python-version }}
       - name: Upload coverage file
         uses: actions/upload-artifact@v3
         with:
@@ -52,18 +74,18 @@ jobs:
       - name: Install Python
         uses: actions/setup-python@v4
         with:
-          python-version: '3.10'
+          python-version: '3.12'
       - name: Download coverage files
         uses: actions/download-artifact@v3
         with:
           name: coverage
-      - run: python -m pip install tox
+      - run: python -m pip install 'tox<4'
       - run: tox -e coverage
   Functests:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.10', '3.9', '3.8']
+        python-version: ['3.12', '3.11', '3.10', '3.9', '3.8']
     name: Functional tests with Python ${{ matrix.python-version }}
     steps:
       - uses: actions/checkout@v3
@@ -71,5 +93,5 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
-      - run: python -m pip install tox
+      - run: python -m pip install 'tox<4'
       - run: tox -e functests

tox_envfile-0.0.6/.github/workflows/slack.yml

@@ -0,0 +1,18 @@
+name: Slack
+on:
+  workflow_run:
+    workflows: [CI]
+    types: [completed]
+    branches: [main]
+jobs:
+  on-failure:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'failure' }}
+    steps:
+      - name: Post to Slack
+        uses: slackapi/slack-github-action@v1.24.0
+        with:
+          channel-id: 'C4K6M7P5E'
+          slack-message: "A workflow run failed\n*Repo:* `${{ github.event.repository.full_name }}` (${{ github.event.repository.html_url }})\n*Workflow:* ${{ github.event.workflow.name }} (${{ github.event.workflow.html_url }})\n*Branch:* `${{ github.event.workflow_run.head_branch }}`\n*Commit:* `${{ github.event.workflow_run.head_commit.id }}`\n*Run:* ${{ github.event.workflow_run.html_url }}\n*Conclusion:* ${{ github.event.workflow_run.conclusion }}"
+        env:
+          SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}

{tox-envfile-0.0.4 → tox_envfile-0.0.6}/.gitignore

@@ -9,4 +9,5 @@ yarn-error.log
 supervisord.log
 supervisord.pid
 .DS_Store
-.devdata.env
+.devdata*
+.eslintcache

tox_envfile-0.0.6/.python-version

@@ -0,0 +1,5 @@
+3.12.4
+3.11.9
+3.10.14
+3.9.19
+3.8.19

{tox-envfile-0.0.4 → tox_envfile-0.0.6}/Makefile

@@ -4,6 +4,10 @@ comma := ,
 help = help::; @echo $$$$(tput bold)$(strip $(1)):$$$$(tput sgr0) $(strip $(2))
 $(call help,make help,print this help message)
 
+.PHONY: services
+
+.PHONY: devdata
+
 .PHONY: shell
 $(call help,make shell,"launch a Python shell in this project's virtualenv")
 shell: python
@@ -14,6 +18,11 @@ $(call help,make lint,"lint the code and print any warnings")
 lint: python
 	@pyenv exec tox -qe lint
 
+.PHONY: typecheck
+$(call help,make typecheck,"type check the code and print any warnings")
+typecheck: python
+	@pyenv exec tox -qe typecheck
+
 .PHONY: format
 $(call help,make format,"format the code")
 format: python
@@ -25,33 +34,50 @@ checkformatting: python
 	@pyenv exec tox -qe checkformatting
 
 .PHONY: test
-$(call help,make test,"run the unit tests in Python 3.10")
-coverage: test
+$(call help,make test,"run the unit tests in Python 3.12")
 test: python
 	@pyenv exec tox -qe tests
 
+.PHONY: test-py311
+$(call help,make test-py311,"run the unit tests in Python 3.11")
+test-py311: python
+	@pyenv exec tox -qe py311-tests
+
+.PHONY: test-py310
+$(call help,make test-py310,"run the unit tests in Python 3.10")
+test-py310: python
+	@pyenv exec tox -qe py310-tests
+
 .PHONY: test-py39
 $(call help,make test-py39,"run the unit tests in Python 3.9")
-coverage: test-py39
 test-py39: python
 	@pyenv exec tox -qe py39-tests
 
 .PHONY: test-py38
 $(call help,make test-py38,"run the unit tests in Python 3.8")
-coverage: test-py38
 test-py38: python
 	@pyenv exec tox -qe py38-tests
 
 .PHONY: coverage
 $(call help,make coverage,"run the tests and print the coverage report")
 coverage: python
-	@pyenv exec tox -qe coverage
+	@pyenv exec tox --parallel -qe 'tests,py{311,310,39,38}-tests,coverage'
 
 .PHONY: functests
-$(call help,make functests,"run the functional tests in Python 3.10")
+$(call help,make functests,"run the functional tests in Python 3.12")
 functests: python
 	@pyenv exec tox -qe functests
 
+.PHONY: functests-py311
+$(call help,make functests-py311,"run the functional tests in Python 3.11")
+functests-py311: python
+	@pyenv exec tox -qe py311-functests
+
+.PHONY: functests-py310
+$(call help,make functests-py310,"run the functional tests in Python 3.10")
+functests-py310: python
+	@pyenv exec tox -qe py310-functests
+
 .PHONY: functests-py39
 $(call help,make functests-py39,"run the functional tests in Python 3.9")
 functests-py39: python
@@ -64,8 +90,9 @@ functests-py38: python
 
 .PHONY: sure
 $(call help,make sure,"make sure that the formatting$(comma) linting and tests all pass")
+sure: python
 sure:
-	@pyenv exec tox --parallel -qe 'checkformatting,lint,tests,py{39,38}-tests,coverage,functests,py{39,38}-functests'
+	@pyenv exec tox --parallel -qe 'checkformatting,lint,typecheck,tests,py{311,310,39,38}-tests,coverage,functests,py{311,310,39,38}-functests'
 
 .PHONY: template
 $(call help,make template,"update from the latest cookiecutter template")
@@ -75,7 +102,7 @@ template: python
 .PHONY: clean
 $(call help,make clean,"delete temporary files etc")
 clean:
-	@rm -rf build dist .tox
+	@rm -rf build dist .tox .coverage coverage .eslintcache node_modules supervisord.log supervisord.pid yarn-error.log
 	@find . -path '*/__pycache__*' -delete
 	@find . -path '*.egg-info*' -delete
 

tox_envfile-0.0.6/PKG-INFO

@@ -0,0 +1,206 @@
+Metadata-Version: 2.1
+Name: tox-envfile
+Version: 0.0.6
+Summary: Load env files in your tox envs.
+Home-page: https://github.com/hypothesis/tox-envfile
+Project-URL: Bug Tracker, https://github.com/hypothesis/tox-envfile/issues
+Project-URL: Changelog, https://github.com/hypothesis/tox-envfile/releases
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Intended Audience :: Developers
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: python-dotenv
+
+<a href="https://github.com/hypothesis/tox-envfile/actions/workflows/ci.yml?query=branch%3Amain"><img src="https://img.shields.io/github/actions/workflow/status/hypothesis/tox-envfile/ci.yml?branch=main"></a>
+<a href="https://pypi.org/project/tox-envfile"><img src="https://img.shields.io/pypi/v/tox-envfile"></a>
+<a><img src="https://img.shields.io/badge/python-3.12 | 3.11 | 3.10 | 3.9 | 3.8-success"></a>
+<a href="https://github.com/hypothesis/tox-envfile/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-BSD--2--Clause-success"></a>
+<a href="https://github.com/hypothesis/cookiecutters/tree/main/pypackage"><img src="https://img.shields.io/badge/cookiecutter-pypackage-success"></a>
+<a href="https://black.readthedocs.io/en/stable/"><img src="https://img.shields.io/badge/code%20style-black-000000"></a>
+
+# tox-envfile
+
+Load env files in your tox envs.
+
+tox-envfile reads environment variables from a file named `.devdata.env` in the
+same directory as your `tox.ini` file and adds them to the environment that tox
+runs your commands in.
+
+This is a pretty dumb plugin for now: all of the environment variables in
+`.devdata.env` will be loaded into the environment for every tox env that you
+run, unconditionally. Any existing envvars with conflicting names will be
+overwritten. Only a single environment file is supported and it must be named
+`.devdata.env`.
+
+env File Format
+---------------
+
+[python-dotenv](https://saurabh-kumar.com/python-dotenv/) is used for the env file parsing.
+
+The `.devdata.env` file should be an env file with contents that look like
+this:
+
+```shell
+# a comment that will be ignored.
+REDIS_ADDRESS=localhost:6379
+MEANING_OF_LIFE=42
+MULTILINE_VAR="hello\nworld"
+```
+
+Or like this:
+
+```shell
+export S3_BUCKET=YOURS3BUCKET
+export SECRET_KEY=YOURSECRETKEYGOESHERE
+```
+
+POSIX variable expansion works, using variables from the environment or from
+earlier lines in the env file:
+
+```shell
+CONFIG_PATH=${HOME}/.config/foo
+DOMAIN=example.org
+EMAIL=admin@${DOMAIN}
+```
+
+## Setting up Your tox-envfile Development Environment
+
+First you'll need to install:
+
+* [Git](https://git-scm.com/).
+  On Ubuntu: `sudo apt install git`, on macOS: `brew install git`.
+* [GNU Make](https://www.gnu.org/software/make/).
+  This is probably already installed, run `make --version` to check.
+* [pyenv](https://github.com/pyenv/pyenv).
+  Follow the instructions in pyenv's README to install it.
+  The **Homebrew** method works best on macOS.
+  The **Basic GitHub Checkout** method works best on Ubuntu.
+  You _don't_ need to set up pyenv's shell integration ("shims"), you can
+  [use pyenv without shims](https://github.com/pyenv/pyenv#using-pyenv-without-shims).
+
+Then to set up your development environment:
+
+```terminal
+git clone https://github.com/hypothesis/tox-envfile.git
+cd tox-envfile
+make help
+```
+
+## Releasing a New Version of the Project
+
+1. First, to get PyPI publishing working you need to go to:
+   <https://github.com/organizations/hypothesis/settings/secrets/actions/PYPI_TOKEN>
+   and add tox-envfile to the `PYPI_TOKEN` secret's selected
+   repositories.
+
+2. Now that the tox-envfile project has access to the `PYPI_TOKEN` secret
+   you can release a new version by just [creating a new GitHub release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository).
+   Publishing a new GitHub release will automatically trigger
+   [a GitHub Actions workflow](.github/workflows/pypi.yml)
+   that will build the new version of your Python package and upload it to
+   <https://pypi.org/project/tox-envfile>.
+
+## Changing the Project's Python Versions
+
+To change what versions of Python the project uses:
+
+1. Change the Python versions in the
+   [cookiecutter.json](.cookiecutter/cookiecutter.json) file. For example:
+
+   ```json
+   "python_versions": "3.10.4, 3.9.12",
+   ```
+
+2. Re-run the cookiecutter template:
+
+   ```terminal
+   make template
+   ```
+
+3. Commit everything to git and send a pull request
+
+## Changing the Project's Python Dependencies
+
+To change the production dependencies in the `setup.cfg` file:
+
+1. Change the dependencies in the [`.cookiecutter/includes/setuptools/install_requires`](.cookiecutter/includes/setuptools/install_requires) file.
+   If this file doesn't exist yet create it and add some dependencies to it.
+   For example:
+
+   ```
+   pyramid
+   sqlalchemy
+   celery
+   ```
+
+2. Re-run the cookiecutter template:
+
+   ```terminal
+   make template
+   ```
+
+3. Commit everything to git and send a pull request
+
+To change the project's formatting, linting and test dependencies:
+
+1. Change the dependencies in the [`.cookiecutter/includes/tox/deps`](.cookiecutter/includes/tox/deps) file.
+   If this file doesn't exist yet create it and add some dependencies to it.
+   Use tox's [factor-conditional settings](https://tox.wiki/en/latest/config.html#factors-and-factor-conditional-settings)
+   to limit which environment(s) each dependency is used in.
+   For example:
+
+   ```
+   lint: flake8,
+   format: autopep8,
+   lint,tests: pytest-faker,
+   ```
+
+2. Re-run the cookiecutter template:
+
+   ```terminal
+   make template
+   ```
+
+3. Commit everything to git and send a pull request
+
+Testing Manually
+----------------
+
+To test it manually you can install your local development copy of
+`tox-envfile` into the local development environment of another tox-using
+project such as
+[cookiecutter-pypackage-test](https://github.com/hypothesis/cookiecutter-pypackage-test):
+
+1. Install a local development copy of `cookiecutter-pypackage-test` in a temporary directory:
+
+   ```terminal
+   git clone https://github.com/hypothesis/cookiecutter-pypackage-test.git /tmp/cookiecutter-pypackage-test
+   ```
+
+2. Run `cookiecutter-pypackage-test`'s `make sure` command to make sure that
+   everything is working and to trigger tox to create its `.tox/.tox`
+   venv:
+
+   ```terminal
+   make --directory "/tmp/cookiecutter-pypackage-test" sure
+   ```
+
+3. Uninstall the production copy of `tox-envfile` from `cookiecutter-pypackage-test`'s `.tox/.tox` venv:
+
+   ```terminal
+   /tmp/cookiecutter-pypackage-test/.tox/.tox/bin/pip uninstall tox-envfile
+   ```
+
+4. Install your local development copy of `tox-envfile` into `cookiecutter-pypackage-test`'s `.tox/.tox` venv:
+
+   ```terminal
+   /tmp/cookiecutter-pypackage-test/.tox/.tox/bin/pip install -e .
+   ```
+
+5. Now `cookiecutter-pypackage-test` commands will use your local development copy of `tox-envfile`:
+
+   ```terminal
+   make --directory "/tmp/cookiecutter-pypackage-test" test
+   ```