DS-2230/rename

.ci/test.sh

@@ -5,6 +5,6 @@
 set -e
 
 pytest
-flake8 creevey tests
-black creevey tests --skip-string-normalization --check
+flake8 wildebeest tests
+black wildebeest tests --skip-string-normalization --check
 sphinx-build docs docs/_html

.github/pull_request_template.md

@@ -1,22 +1,25 @@
-Contributors from outside ShopRunner should feel free to submit a PR without having completed all of the items below. See [CONTRIBUTING.md](https://github.com/ShopRunner/creevey/blob/master/CONTRIBUTING.md) for additional information. 
+# Pull Request Process
 
-**General Pull Request Checklist**
+Contributors from outside ShopRunner should feel free to submit a PR without having completed all of the items below. See [CONTRIBUTING.md](https://github.com/ShopRunner/wildebeest/blob/master/CONTRIBUTING.md) for additional information.
 
- - [ ] Pull request has been made against the `wip` branch (or from `wip` into `master`).
- - [ ] Pull request includes a description of the change and the reason behind it.
- - [ ] Pull request [uses keywords](https://help.github.com/en/articles/closing-issues-using-keywords) to close relevant [issues](https://github.com/ShopRunner/creevey/issues).
- - [ ] Pull request includes unit tests for any bug fixes and new functionality.
- - [ ] `./.ci/test.sh` passes locally.
- - [ ] Docs have been updated as needed. (`./.ci/test.sh` rebuilds the docs. Open `docs/_html/index.html` to check them.)
-
-The maintainer will complete the following steps for external contributions.
+You can run `./.ci/test.sh` locally to check for style issues, run tests, rebuild docs, etc. before submitting changes.
 
-**Additional Items for ShopRunner Contributors**
+## Description
 
- - [ ] `CHANGELOG.md` has been updated.
- - [ ] `_version.py` has been updated.
- - [ ] Version number has been updated in `docs/conf.py`.
+DESCRIBE THE CHANGE AND EXPLAIN THE REASON BEHIND IT
 
-**For merges from `wip` to `master`**::
+## Checklist
 
- - [ ] Confirm that docs build correctly on [readthedocs](https://readthedocs.org/projects/creevey/builds/).
+### General
+
+- [ ] Pull request [uses keywords](https://help.github.com/en/articles/closing-issues-using-keywords) to close relevant [issues](https://github.com/ShopRunner/wildebeest/issues).
+- [ ] Pull request includes unit tests for any bug fixes and new functionality.
+- [ ] Docs have been updated as needed. (`sphinx-build docs docs/_html` rebuilds the docs. Open `docs/_html/index.html` to check them.)
+
+### ShopRunner Contributors
+
+The maintainer will complete the following steps for contributions from outside ShopRunner.
+
+- [ ] `CHANGELOG.md` has been updated.
+- [ ] `_version.py` has been updated.
+- [ ] Version number has been updated in `docs/conf.py`.

.github/workflows/pr.yaml

@@ -0,0 +1,33 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Python package
+
+on:
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.6, 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 --upgrade pip
+        python -m pip install .
+        python -m pip install -r requirements-dev.txt
+    - name: Run checks and build docs
+      run: .ci/test.sh
+    - name: Verify build
+      run: |
+        pip install --upgrade pip wheel twine
+        python setup.py sdist bdist_wheel

.github/workflows/prod.yaml

@@ -0,0 +1,52 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Python package
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.6, 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 --upgrade pip
+        python -m pip install .
+        python -m pip install -r requirements-dev.txt
+    - name: Run checks and build docs
+      run: |
+        .ci/test.sh
+
+  publish:
+
+    runs-on: ubuntu-latest
+    needs: [test]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        python setup.py sdist bdist_wheel
+        twine upload dist/*

CHANGELOG.md

@@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 
+#[3.0.0] - 2020-7-28
+### Changed
+ - Rename library "wildebeest"
+ - Use GitHub Actions for CI/CD.
+
+==== Below is Creevey development ====
+
+#[3.0.0] - 2020-7-28
+### Added
+ - Warning about upcoming name change
+
 #[2.3.0] - 2020-7-24
 ### Added 
  - Use `pip-tools`.

CONTRIBUTING.md

@@ -6,7 +6,7 @@ We welcome contributions in the form of issues or pull requests!
 
 We want this to be a place where all are welcome to discuss and contribute, so please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. Find the code of conduct in the ``CONDUCT.md`` file on GitHub.
 
-If you have a problem using Creevey or see a possible improvement, open an issue in the GitHub issue tracker. Please be as specific as you can.
+If you have a problem using Wildebeest or see a possible improvement, open an issue in the GitHub issue tracker. Please be as specific as you can.
 
 If you see an open issue you'd like to be fixed, take a stab at it and open a PR!
 
@@ -16,7 +16,7 @@ If you see an open issue you'd like to be fixed, take a stab at it and open a PR
 2. Clone the forked repo to your local disk. 
 
 ```bash
-git clone https://github.com/<your_github_user_name>/creevey.git
+git clone https://github.com/<your_github_user_name>/wildebeest.git
 ```
 
 3. `cd` into the directory.
@@ -33,11 +33,11 @@ pip install -e .
 ```
 
 6. Make your changes.
-7. Complete all items in the [pull request checklist](https://github.com/ShopRunner/creevey/blob/master/.github/pull_request_template.md) that you feel comfortable with. Feel free to submit a PR with some loose ends, particularly if you are not sure about how to complete a checklist item.
+7. Complete all items in the [pull request checklist](https://github.com/ShopRunner/wildebeest/blob/master/.github/pull_request_template.md) that you feel comfortable with. Feel free to submit a PR with some loose ends, particularly if you are not sure about how to complete a checklist item.
 8. Submit your PR against the `wip` branch.
 
 ## Additional Notes
 
 - We prefer single quotes for one-libe strings unless using double quotes allows us to avoid escaping internal single quotes.
 - We use [numpy style](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html) for docstrings.
-- We want Creevey to be compatible with Python 3.6+.
+- We want Wildebeest to be compatible with Python 3.6+.

README.md

@@ -1,9 +1,11 @@
-# Creevey
+# Wildebeest
 
-> **Note 6/15/20:** Our team previously had a tradition of naming projects with terms or characters from the Harry Potter series, but we are disappointed by J.K. Rowling’s persistent transphobic comments. In response, we will be renaming this repository, and are working to develop an inclusive solution that minimizes disruption to our users.
+![wildebeest stampede](docs/images/wildebeest_stampede.jpg)
 
-Creevey is a file processing framework. It is designed for IO-bound workflows that involve reading files into memory, doing some processing on their contents, and writing out the results. It makes running those workflows faster and more reliable by parallelizing them across files, optional skipping files that have already been processed, handling errors, and keeping organized records of what happened.
+Wildebeest is a file processing framework. It is designed for IO-bound workflows that involve reading files into memory, doing some processing on their contents, and writing out the results. It makes running those workflows faster and more reliable by parallelizing them across files, optional skipping files that have already been processed, handling errors, and keeping organized records of what happened.
 
-Creevey was developed for deep learning computer vision projects, so in addition to the general framework it also provides predefined components for image processing. However, it can be used for any project that involves processing data from many sources.
+Wildebeest was developed for deep learning computer vision projects, so in addition to the general framework it also provides predefined components for image processing. However, it can be used for any project that involves processing data from many sources.
 
-See [the docs](https://creevey.readthedocs.io/) for more details.
+See [the docs](https://wildebeest.readthedocs.io/) for more details.
+
+Wildebeest was known as Creevey until version 3.0.0.

docs/api.rst

@@ -1,22 +1,22 @@
 API
 ===
 
-Generally, each module has a submodule which shares its name that defines generic components and an ``image`` submodule that defines components for working with images. Items in the former are imported into the module namespace, so that you can write e.g. from ``creevey.path_funcs import combine_outdir_dirname_extension`` rather than ``from creevey.path_funcs.path_funcs import combine_outdir_dirname_extension``.
+Generally, each module has a submodule which shares its name that defines generic components and an ``image`` submodule that defines components for working with images. Items in the former are imported into the module namespace, so that you can write e.g. from ``wildebeest.path_funcs import combine_outdir_dirname_extension`` rather than ``from wildebeest.path_funcs.path_funcs import combine_outdir_dirname_extension``.
 
 pipelines
 ---------
 
 pipelines
 ^^^^^^^^^
 
-.. automodule:: creevey.pipelines.pipelines
+.. automodule:: wildebeest.pipelines.pipelines
    :special-members: __call__
    :members:
 
 image
 ^^^^^
 
-.. automodule:: creevey.pipelines.image
+.. automodule:: wildebeest.pipelines.image
    :members:
 
 load_funcs
@@ -25,13 +25,13 @@ load_funcs
 load_funcs
 ^^^^^^^^^^
 
-.. automodule:: creevey.load_funcs.load_funcs
+.. automodule:: wildebeest.load_funcs.load_funcs
    :members:
 
 image
 ^^^^^
 
-.. automodule:: creevey.load_funcs.image
+.. automodule:: wildebeest.load_funcs.image
    :members:
 
 ops
@@ -43,7 +43,7 @@ helpers
 report
 """"""
 
-.. automodule:: creevey.ops.helpers.report
+.. automodule:: wildebeest.ops.helpers.report
    :members:
 
 image
@@ -52,13 +52,13 @@ image
 stats
 """""
 
-.. automodule:: creevey.ops.image.stats
+.. automodule:: wildebeest.ops.image.stats
    :members:
 
 transforms
 """"""""""
 
-.. automodule:: creevey.ops.image.transforms
+.. automodule:: wildebeest.ops.image.transforms
    :members:
 
 path_funcs
@@ -67,7 +67,7 @@ path_funcs
 path_funcs
 ^^^^^^^^^^
 
-.. automodule:: creevey.path_funcs.path_funcs
+.. automodule:: wildebeest.path_funcs.path_funcs
    :members:
 
 write_funcs
@@ -76,7 +76,7 @@ write_funcs
 image
 ^^^^^
 
-.. automodule:: creevey.write_funcs.image
+.. automodule:: wildebeest.write_funcs.image
    :members:
 
 util
@@ -85,17 +85,17 @@ util
 util
 ^^^^
 
-.. automodule:: creevey.util.util
+.. automodule:: wildebeest.util.util
    :members:
 
 image
 ^^^^^
 
-.. automodule:: creevey.util.image
+.. automodule:: wildebeest.util.image
    :members:
 
 constants
 ---------
 
-.. automodule:: creevey.constants
+.. automodule:: wildebeest.constants
    :members:

docs/conf.py

@@ -15,15 +15,15 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath('../creevey'))
+sys.path.insert(0, os.path.abspath('../wildebeest'))
 
 # -- Project information -----------------------------------------------------
 
-project = 'creevey'
+project = 'wildebeest'
 copyright = '2019 Shoprunner'
 author = 'gsganden, sugi-chan'
 
-release = version = '2.3.0'
+release = version = '3.0.0'
 
 # -- General configuration ---------------------------------------------------
 
@@ -115,7 +115,7 @@
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'creeveydoc'
+htmlhelp_basename = 'wildebeestdoc'
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -141,8 +141,8 @@
 latex_documents = [
     (
         master_doc,
-        'creevey.tex',
-        'creevey Documentation',
+        'wildebeest.tex',
+        'wildebeest Documentation',
         'gsganden, sugi-chan',
         'manual',
     )
@@ -153,7 +153,7 @@
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [(master_doc, 'creevey', 'creevey Documentation', [author], 1)]
+man_pages = [(master_doc, 'wildebeest', 'wildebeest Documentation', [author], 1)]
 
 
 # -- Options for Texinfo output ----------------------------------------------
@@ -164,10 +164,10 @@
 texinfo_documents = [
     (
         master_doc,
-        'creevey',
-        'creevey Documentation',
+        'wildebeest',
+        'wildebeest Documentation',
         author,
-        'creevey',
+        'wildebeest',
         'One line description of project.',
         'Miscellaneous',
     )