moved all files out of group package to increase accessibility

hmartin11 · Apr 9, 2022 · 72fb03d · 72fb03d
1 parent c7aa629
commit 72fb03d
Show file tree

Hide file tree

Showing 38 changed files with 310 additions and 248 deletions.
diff --git a/group4package/CONTRIBUTING.md → ...nb_checkpoints/CONTRIBUTING-checkpoint.md b/group4package/CONTRIBUTING.md → ...nb_checkpoints/CONTRIBUTING-checkpoint.md
diff --git a/group4package/pyproject.toml → .ipynb_checkpoints/pyproject-checkpoint.toml b/group4package/pyproject.toml → .ipynb_checkpoints/pyproject-checkpoint.toml
diff --git a/group4package/CHANGELOG.md → CHANGELOG.md b/group4package/CHANGELOG.md → CHANGELOG.md
diff --git a/group4package/CONDUCT.md → CONDUCT.md b/group4package/CONDUCT.md → CONDUCT.md
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,73 @@
+# Contributing
+
+Contributions are welcome, and they are greatly appreciated! Every little bit
+helps, and credit will always be given.
+
+## Types of Contributions
+
+### Report Bugs
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+### Fix Bugs
+
+Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
+wanted" is open to whoever wants to implement it.
+
+### Implement Features
+
+Look through the GitHub issues for features. Anything tagged with "enhancement"
+and "help wanted" is open to whoever wants to implement it.
+
+### Write Documentation
+
+You can never have enough documentation! Please feel free to contribute to any
+part of the documentation, such as the official docs, docstrings, or even 
+on the web in blog posts, articles, and such.
+
+### Submit Feedback
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+## Get Started!
+
+Ready to contribute? Here's how to set up `group4package` for local development.
+
+1. Download a copy of `group4package` locally.
+2. Install `group4package` using `poetry`:
+
+    ```console
+    $ poetry install
+    ```
+
+3. Use `git` (or similar) to create a branch for local development and make your changes:
+
+    ```console
+    $ git checkout -b name-of-your-bugfix-or-feature
+    ```
+
+4. When you're done making changes, check that your changes conform to any code formatting requirements and pass any tests.
+
+5. Commit your changes and open a pull request.
+
+## Pull Request Guidelines
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include additional tests if appropriate.
+2. If the pull request adds functionality, the docs should be updated.
+3. The pull request should work for all currently supported operating systems and versions of Python.
+
+## Code of Conduct
+
+Please note that the `group4package` project is released with a 
+Code of Conduct. By contributing to this project you agree to abide by its terms.
diff --git a/group4package/LICENSE → LICENSE b/group4package/LICENSE → LICENSE
diff --git a/group4package/README.md → README.md b/group4package/README.md → README.md
diff --git a/group4package/docs/conf.py → docs/.ipynb_checkpoints/conf-checkpoint.py b/group4package/docs/conf.py → docs/.ipynb_checkpoints/conf-checkpoint.py
diff --git a/group4package/docs/Makefile → docs/Makefile b/group4package/docs/Makefile → docs/Makefile
diff --git a/group4package/docs/changelog.md → docs/changelog.md b/group4package/docs/changelog.md → docs/changelog.md
diff --git a/group4package/docs/conduct.md → docs/conduct.md b/group4package/docs/conduct.md → docs/conduct.md
diff --git a/docs/conf.py b/docs/conf.py
@@ -0,0 +1,36 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+
+project = u"group4package"
+copyright = u"2022, Hannah, Jordan, Diana, Shravan"
+author = u"Hannah, Jordan, Diana, Shravan"
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "myst_nb",
+    "autoapi.extension",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+]
+autoapi_dirs = ["../src"]
+
+# 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 = ["_build", "Thumbs.db", ".DS_Store"]
+
+# -- 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 = "sphinx_rtd_theme"
diff --git a/group4package/docs/contributing.md → docs/contributing.md b/group4package/docs/contributing.md → docs/contributing.md
diff --git a/group4package/docs/example.ipynb → docs/example.ipynb b/group4package/docs/example.ipynb → docs/example.ipynb
diff --git a/group4package/docs/index.md → docs/index.md b/group4package/docs/index.md → docs/index.md
diff --git a/group4package/docs/make.bat → docs/make.bat b/group4package/docs/make.bat → docs/make.bat
diff --git a/group4package/docs/requirements.txt → docs/requirements.txt b/group4package/docs/requirements.txt → docs/requirements.txt
diff --git a/group4package/.github/workflows/ci-cd.yml b/group4package/.github/workflows/ci-cd.yml
diff --git a/group4package/.gitignore b/group4package/.gitignore
diff --git a/group4package/.readthedocs.yml b/group4package/.readthedocs.yml
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,26 @@
+[tool.poetry]
+name = "group4package"
+version = "0.1.0"
+description = "A package for doing great things!"
+authors = ["Hannah Martin"]
+license = "MIT"
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.9"
+
+[tool.poetry.dev-dependencies]
+[tool.semantic_release]
+version_variable = "pyproject.toml:version" # version location
+branch = "main"                             # branch to make releases of
+changelog_file = "CHANGELOG.md"             # changelog file
+build_command = "poetry build"              # build dists
+dist_path = "dist/"                         # where to put dists
+upload_to_release = true                    # auto-create GitHub release
+upload_to_pypi = false                      # don't auto-upload to PyPI
+remove_dist = false                         # don't remove dists
+patch_without_tag = true                    # patch release by default
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
diff --git a/.../src/group4package/function_count_plot.py → ...kpoints/function_count_plot-checkpoint.py b/.../src/group4package/function_count_plot.py → ...kpoints/function_count_plot-checkpoint.py
diff --git a/...rc/group4package/metrics_function copy.py → ...heckpoints/metrics_function-checkpoint.py b/...rc/group4package/metrics_function copy.py → ...heckpoints/metrics_function-checkpoint.py
diff --git a/...p4package/src/group4package/preprocess.py → ...pynb_checkpoints/preprocess-checkpoint.py b/...p4package/src/group4package/preprocess.py → ...pynb_checkpoints/preprocess-checkpoint.py
diff --git a/group4package/src/group4package/__init__.py → src/group4package/__init__.py b/group4package/src/group4package/__init__.py → src/group4package/__init__.py