enh: coc and readme update

Author: lwasser

CODE_OF_CONDUCT.md

@@ -0,0 +1,3 @@
+# pyOpenSci Code of Conduct
+
+[The pyOpenSci Code of Conduct can be found here.](https://www.pyopensci.org/handbook/CODE_OF_CONDUCT.html)

README.md

@@ -8,8 +8,10 @@
 > A Python package template that supports the pyOpenSci
 > pure [Python packaging tutorial](https://www.pyopensci.org/python-package-guide/tutorials/intro.html).
 This template can be used with [copier](https://copier.readthedocs.io) to initialize a
-new Python package project structure following the practices outlined in the pyOpenSci
-tutorial.
+new Python package project structure following the practices outlined in the
+[pyOpenSci pure Python packaging tutorial](https://www.pyopensci.org/python-package-guide/tutorials/installable-code.html).
+
+If you want to learn more about packaging, check out our [Python packaging guide](https://www.pyopensci.org/python-package-guide/).
 
 ## Get started
 
@@ -73,49 +75,55 @@ short. This workflow creates the simplest version of a Python package including
 `tests\` directory and a `docs\` directory using Sphinx.
 
 ```console
-pyos-package-template (☊ minimal) [🏎️ 💨 ×6] via 🐍 v3.12.5 (test.py3.12)
-➜ copier copy . _law_tests --vcs-ref minimal
-🎤 Who is the copyright holder, for example, yourself or your organization? Used in the license file and project description.
-   Your Name
-🎤 Who is the author of the package to be? Used in the package description.
-  Your Name
-🎤 The author's email address. Used in the package description.
-   email@youremail.com
-🎤 What is the name of the project? Used as the title in the README.md and other places.
-   project_name
+➜ copier copy gh:pyopensci/pyos-package-template .
+🎤 "Welcome to the pyOpenSci package template.
+Please select the type of template that you want to create today."
+ >> MINIMAL: I want a minimal setup (package, tests and docs; typing); linting not included).
+    FULL DEFAULT: I want to use the default settings but I want it setup for me.
+    FULL CUSTOM: I want it all but I want to fully customize all template elements.
+🎤 What is the name of the project? Used as the README.md title, in the
+   pyospackage_juno
 🎤 Please provide a short description for the package.
     (Finish with 'Alt+Enter' or 'Esc then Enter')
-> An example Python package with a minimal setup.
-🎤 Do you want to skip all remaining questions and use the default values?
-   >> Yes, but with a minimal setup (package, tests and docs only).
+> A great package that adds and subtracts numbers.
+
+🎤 Who is the author of the package? Used in the package description.
+   juno dawg
+🎤 Provide you or your organization's GitHub username. Used to generate
+   pyopensci
 
-Copying from template version 0.6.1.post44.dev0+7863796
+Copying from template version 0.6.4.1
+ identical  .
     create  CODE_OF_CONDUCT.md
+    create  .gitignore
     create  CHANGELOG.md
-    create  CONTRIBUTING.md
     create  LICENSE
     create  README.md
     create  tests
     create  tests/unit
-    create  tests/unit/.keep
-    create  tests/integration
-    create  tests/integration/.keep
-    create  tests/system
-    create  tests/system/test_import.py
-    create  tests/system/.keep
+    create  tests/unit/test_example.py
  identical  .editorconfig
- identical  .gitignore
+    create  .github
+    create  .github/workflows
+    create  .github/workflows/release.yml
+    create  .github/workflows/test.yml
+    create  .github/PULL_REQUEST_TEMPLATE.md
+    create  .github/ISSUE_TEMPLATE
+    create  .github/ISSUE_TEMPLATE/config.yml
+    create  .github/ISSUE_TEMPLATE/01-bug-report.yml
+    create  CONTRIBUTING.md
     create  docs
     create  docs/conf.py
     create  docs/index.md
     create  pyproject.toml
     create  src
-    create  src/pyopensci
-    create  src/pyopensci/example.py
-    create  src/pyopensci/__init__.py
+    create  src/pyospackage_juno
+    create  src/pyospackage_juno/example.py
+    create  src/pyospackage_juno/__init__.py
 ```
 
-Once you have created your package, you can install it in editable mode using pip:
+Once you have created your package, you can install it in editable mode using
+pip.
 
 First, CD to the directory where your new package lives and install the package in editable mode:
 
@@ -126,7 +134,8 @@ $ pip install -e . # install your package in editable mode
 $ python # open up a python prompt
 ```
 
-We have included a small module in the package in case you want to test it out.
+We have included a small module in the package template in case you want to
+test drive that package in an environment before adding to it.
 
 ```python
 >>> from your_package import example # we have called the sample module, example.py
@@ -136,6 +145,9 @@ We have included a small module in the package in case you want to test it out.
 ```
 
 ### Build your package
+
+The template has Hatch environments setup.
+
 You can build your package using `Hatch` which is included in the template.
 First, make sure you have `Hatch` installed in your environment. Then,
 run `hatch build`.
@@ -148,6 +160,13 @@ dist/yourpackage-0.1.0.tar.gz
 dist/yourpackage-0.1.0-py2.py3-none-any.whl
 ```
 
+To use the hatch build environment run:
+
+`hatch run build:check`
+
+This will create a new `venv` environment and build your package's wheel and
+source distributions.
+
 ### Full customization: A more complex example package
 
 If you want to fully customize your package, then the template workflow will

copier.yml

@@ -6,9 +6,9 @@ template_mode:
     "Welcome to the pyOpenSci package template.
     Please select the type of template that you want to create today."
   choices:
-    "Yes, but with a minimal setup (package, tests and docs; typing, linting not included).": "minimal"
-    "I want to use the default settings but I want it setup for me. ": "full"
-    "I want it all but I want to fully customize all elements of the template.": "custom" # changed from no to to custom
+    "MINIMAL: I want a minimal setup (package, tests and docs; typing); linting not included).": "minimal"
+    "FULL DEFAULT: I want to use the default settings but I want it setup for me.": "full"
+    "FULL CUSTOM: I want it all but I want to fully customize all template elements.": "custom" # changed from no to to custom
 
   default: "minimal"