Package init

ramanathanlab · Dec 22, 2023 · 4c061e6 · 4c061e6
1 parent f2c2780
commit 4c061e6
Show file tree

Hide file tree

Showing 33 changed files with 22 additions and 712 deletions.
diff --git a/.github/ISSUE_TEMPLATE/01_bug.yml b/.github/ISSUE_TEMPLATE/01_bug.yml
@@ -2,28 +2,28 @@ name: Bug Report
 description: Report errors or unexpected results.
 labels: ["bug"]
 assignees:
-  - foobar-bug-assign-dev
+  - pdfwf-bug-assign-dev
 body:
   - type: textarea
     id: install
     attributes:
-      label: How did you install foobar?
+      label: How did you install pdfwf?
       description: >
         E.g., install via pip, install from source, etc. **Note:** this will
         be rendered as console text automatically.
       placeholder: |
-        $ pip install foobar
-        Collecting foobar
+        $ pip install pdfwf
+        Collecting pdfwf
         ...
-        Successfully installed foobar...
+        Successfully installed pdfwf...
       render: console
     validations:
       required: true
 
   - type: input
     id: version
     attributes:
-      label: What version of foobar are you using?
+      label: What version of pdfwf are you using?
       description: >
         Package version if installed via Pip or commit ID if installed
         from source.

diff --git a/.github/ISSUE_TEMPLATE/02_enhancement.yml b/.github/ISSUE_TEMPLATE/02_enhancement.yml
@@ -2,7 +2,7 @@ name: Enhancement Request
 description: Request a new feature or enhancement.
 labels: ["enhancement"]
 assignees:
-  - foobar-enh-assign-dev
+  - pdfwf-enh-assign-dev
 body:
   - type: textarea
     id: request

diff --git a/.github/ISSUE_TEMPLATE/03_docs.yml b/.github/ISSUE_TEMPLATE/03_docs.yml
@@ -2,7 +2,7 @@ name: Documentation Improvements
 description: Suggest improvements to the documentation.
 labels: ["documentation"]
 assignees:
-  - foobar-doc-assignee-dev
+  - pdfwf-doc-assignee-dev
 body:
   - type: textarea
     id: freeform

diff --git a/CITATION.cff b/CITATION.cff
diff --git a/README.md b/README.md
@@ -18,8 +18,8 @@ This package setup was based on [Anthony Sottile's project setup](https://www.yo
 1. Click the "Use this template" button at the top right of this page.
 2. Delete and directories you will not be using (commonly `docs/` if you do not want to use MKDocs or `examples/` if you will not have example code).
 3. Follow the instructions to create the new repo then clone your repo locally.
-4. The template uses "foobar" to indicate things that need to be changed.
-   Start by searching for all instances (`git grep foobar`) and changing them accordingly.
+4. The template uses "pdfwf" to indicate things that need to be changed.
+   Start by searching for all instances (`git grep pdfwf`) and changing them accordingly.
 5. Configure pre-commit:
     - Go to [https://pre-commit.ci/](https://pre-commit.ci/) and enable pre-commit on your repo.
     - Update the pre-commit badge URL in this README with your new badge URL.
@@ -49,7 +49,7 @@ I recommend making a few other changes to the repo's setting on GitHub.
 
 Install via pip:
 ```
-$ pip install foobar
+$ pip install pdfwf
 ```
 
 For local development:

diff --git a/docs/_overrides/base.html b/docs/_overrides/base.html
diff --git a/docs/_templates/python/material/docstring/admonition.html b/docs/_templates/python/material/docstring/admonition.html
diff --git a/docs/_templates/python/material/function.html b/docs/_templates/python/material/function.html
diff --git a/docs/_templates/python/material/module.html b/docs/_templates/python/material/module.html
diff --git a/docs/contributing/index.md b/docs/contributing/index.md
diff --git a/docs/contributing/issues-pull-requests.md b/docs/contributing/issues-pull-requests.md
diff --git a/docs/contributing/releases.md b/docs/contributing/releases.md