Release 🎉

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -6,7 +6,7 @@ body:
 - type: markdown
   attributes:
     value: >
-      #### Before submitting a bug, please make sure the issue hasn't been already addressed by searching through [the existing and past issues](https://github.com/allenai/python-package-template/issues?q=is%3Aissue+sort%3Acreated-desc+).
+      #### Before submitting a bug, please make sure the issue hasn't been already addressed by searching through [the existing and past issues](https://github.com/deldelmax/allennlp-light/issues?q=is%3Aissue+sort%3Acreated-desc+).
 - type: textarea
   attributes:
     label: 🐛 Describe the bug
@@ -17,7 +17,7 @@ body:
 
       ```python
       # All necessary imports at the beginning
-      import my_package
+      import allennlp_light
 
       # A succinct reproducing example trimmed down to the essential parts:
       assert False is True, "Oh no!"

.github/ISSUE_TEMPLATE/documentation.yml

@@ -1,13 +1,13 @@
 name: 📚 Documentation
-description: Report an issue related to https://my-package.readthedocs.io/latest
+description: Report an issue related to https://allennlp-light.readthedocs.io/latest
 labels: 'documentation'
 
 body:
 - type: textarea
   attributes:
     label: 📚 The doc issue
     description: >
-      A clear and concise description of what content in https://my-package.readthedocs.io/latest is an issue.
+      A clear and concise description of what content in https://allennlp-light.readthedocs.io/latest is an issue.
   validations:
     required: true
 - type: textarea

.github/workflows/main.yml

@@ -58,11 +58,6 @@ jobs:
                 isort --check .
                 black --check .
 
-          - python: '3.10'
-            task:
-              name: Docs
-              run: cd docs && make html
-
     steps:
       - uses: actions/checkout@v3
 
@@ -88,7 +83,7 @@ jobs:
         if: always()
         run: |
           . .venv/bin/activate
-          pip uninstall -y my-package
+          pip uninstall -y allennlp-light
 
   release:
     name: Release
@@ -135,4 +130,4 @@ jobs:
           body_path: ${{ github.workspace }}-RELEASE_NOTES.md
           prerelease: ${{ contains(env.TAG, 'rc') }}
           files: |
-            dist/*
+            dist/*

.github/workflows/pr_checks.yml

@@ -9,7 +9,7 @@ on:
     branches:
       - main
     paths:
-      - 'my_package/**'
+      - 'allennlp_light/**'
 
 jobs:
   changelog:

CHANGELOG.md

@@ -6,3 +6,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
+
+## [v0.0.0](https://github.com/deldelmax/allennlp-light/releases/tag/v0.0.0) - 2022-08-11
+## [v1.0.0](https://github.com/deldelmax/allennlp-light/releases/tag/v1.0.0) - 2022-08-11

CONTRIBUTING.md

@@ -6,10 +6,10 @@ Thanks for considering contributing! Please read this document to learn the vari
 
 ### Did you find a bug?
 
-First, do [a quick search](https://github.com/allenai/python-package-template/issues) to see whether your issue has already been reported.
+First, do [a quick search](https://github.com/deldelmax/allennlp-light/issues) to see whether your issue has already been reported.
 If your issue has already been reported, please comment on the existing issue.
 
-Otherwise, open [a new GitHub issue](https://github.com/allenai/python-package-template/issues).  Be sure to include a clear title
+Otherwise, open [a new GitHub issue](https://github.com/deldelmax/allennlp-light/issues).  Be sure to include a clear title
 and description.  The description should include as much relevant information as possible.  The description should
 explain how to reproduce the erroneous behavior as well as the behavior you expect to see.  Ideally you would include a
 code sample or an executable test case demonstrating the expected behavior.
@@ -21,7 +21,7 @@ We use GitHub issues to track feature requests. Before you create a feature requ
 * Make sure you have a clear idea of the enhancement you would like. If you have a vague idea, consider discussing
 it first on a GitHub issue.
 * Check the documentation to make sure your feature does not already exist.
-* Do [a quick search](https://github.com/allenai/python-package-template/issues) to see whether your feature has already been suggested.
+* Do [a quick search](https://github.com/deldelmax/allennlp-light/issues) to see whether your feature has already been suggested.
 
 When creating your request, please:
 
@@ -41,31 +41,31 @@ When you're ready to contribute code to address an open issue, please follow the
 
     Then clone your fork locally with
 
-        git clone https://github.com/USERNAME/python-package-template.git
+        git clone https://github.com/USERNAME/allennlp-light.git
 
     or 
 
-        git clone [email protected]:USERNAME/python-package-template.git
+        git clone [email protected]:USERNAME/allennlp-light.git
 
-    At this point the local clone of your fork only knows that it came from *your* repo, github.com/USERNAME/python-package-template.git, but doesn't know anything the *main* repo, [https://github.com/allenai/python-package-template.git](https://github.com/allenai/python-package-template). You can see this by running
+    At this point the local clone of your fork only knows that it came from *your* repo, github.com/USERNAME/allennlp-light.git, but doesn't know anything the *main* repo, [https://github.com/deldelmax/allennlp-light.git](https://github.com/deldelmax/allennlp-light). You can see this by running
 
         git remote -v
 
     which will output something like this:
 
-        origin https://github.com/USERNAME/python-package-template.git (fetch)
-        origin https://github.com/USERNAME/python-package-template.git (push)
+        origin https://github.com/USERNAME/allennlp-light.git (fetch)
+        origin https://github.com/USERNAME/allennlp-light.git (push)
 
-    This means that your local clone can only track changes from your fork, but not from the main repo, and so you won't be able to keep your fork up-to-date with the main repo over time. Therefore you'll need to add another "remote" to your clone that points to [https://github.com/allenai/python-package-template.git](https://github.com/allenai/python-package-template). To do this, run the following:
+    This means that your local clone can only track changes from your fork, but not from the main repo, and so you won't be able to keep your fork up-to-date with the main repo over time. Therefore you'll need to add another "remote" to your clone that points to [https://github.com/deldelmax/allennlp-light.git](https://github.com/deldelmax/allennlp-light). To do this, run the following:
 
-        git remote add upstream https://github.com/allenai/python-package-template.git
+        git remote add upstream https://github.com/deldelmax/allennlp-light.git
 
     Now if you do `git remote -v` again, you'll see
 
-        origin https://github.com/USERNAME/python-package-template.git (fetch)
-        origin https://github.com/USERNAME/python-package-template.git (push)
-        upstream https://github.com/allenai/python-package-template.git (fetch)
-        upstream https://github.com/allenai/python-package-template.git (push)
+        origin https://github.com/USERNAME/allennlp-light.git (fetch)
+        origin https://github.com/USERNAME/allennlp-light.git (push)
+        upstream https://github.com/deldelmax/allennlp-light.git (fetch)
+        upstream https://github.com/deldelmax/allennlp-light.git (push)
 
     Finally, you'll need to create a Python 3 virtual environment suitable for working on this project. There a number of tools out there that making working with virtual environments easier.
     The most direct way is with the [`venv` module](https://docs.python.org/3.7/library/venv.html) in the standard library, but if you're new to Python or you don't already have a recent Python 3 version installed on your machine,
@@ -77,8 +77,8 @@ When you're ready to contribute code to address an open issue, please follow the
 
     Then you can create and activate a new Python environment by running:
 
-        conda create -n my-package python=3.9
-        conda activate my-package
+        conda create -n allennlp-light python=3.9
+        conda activate allennlp-light
 
     Once your virtual environment is activated, you can install your local clone in "editable mode" with
 
@@ -93,7 +93,7 @@ When you're ready to contribute code to address an open issue, please follow the
 
     <details><summary>Expand details 👇</summary><br/>
 
-    Once you've added an "upstream" remote pointing to [https://github.com/allenai/python-package-temlate.git](https://github.com/allenai/python-package-template), keeping your fork up-to-date is easy:
+    Once you've added an "upstream" remote pointing to [https://github.com/allenai/python-package-temlate.git](https://github.com/deldelmax/allennlp-light), keeping your fork up-to-date is easy:
 
         git checkout main  # if not already on main
         git pull --rebase upstream main
@@ -119,7 +119,7 @@ When you're ready to contribute code to address an open issue, please follow the
 
     <details><summary>Expand details 👇</summary><br/>
 
-    Our continuous integration (CI) testing runs [a number of checks](https://github.com/allenai/python-package-template/actions) for each pull request on [GitHub Actions](https://github.com/features/actions). You can run most of these tests locally, which is something you should do *before* opening a PR to help speed up the review process and make it easier for us.
+    Our continuous integration (CI) testing runs [a number of checks](https://github.com/deldelmax/allennlp-light/actions) for each pull request on [GitHub Actions](https://github.com/features/actions). You can run most of these tests locally, which is something you should do *before* opening a PR to help speed up the review process and make it easier for us.
 
     First, you should run [`isort`](https://github.com/PyCQA/isort) and [`black`](https://github.com/psf/black) to make sure you code is formatted consistently.
     Many IDEs support code formatters as plugins, so you may be able to setup isort and black to run automatically everytime you save.
@@ -129,23 +129,23 @@ When you're ready to contribute code to address an open issue, please follow the
         isort .
         black .
 
-    Our CI also uses [`flake8`](https://github.com/allenai/python-package-template/tree/main/tests) to lint the code base and [`mypy`](http://mypy-lang.org/) for type-checking. You should run both of these next with
+    Our CI also uses [`flake8`](https://github.com/deldelmax/allennlp-light/tree/main/tests) to lint the code base and [`mypy`](http://mypy-lang.org/) for type-checking. You should run both of these next with
 
         flake8 .
 
     and
 
         mypy .
 
-    We also strive to maintain high test coverage, so most contributions should include additions to [the unit tests](https://github.com/allenai/python-package-template/tree/main/tests). These tests are run with [`pytest`](https://docs.pytest.org/en/latest/), which you can use to locally run any test modules that you've added or changed.
+    We also strive to maintain high test coverage, so most contributions should include additions to [the unit tests](https://github.com/deldelmax/allennlp-light/tree/main/tests). These tests are run with [`pytest`](https://docs.pytest.org/en/latest/), which you can use to locally run any test modules that you've added or changed.
 
-    For example, if you've fixed a bug in `my_package/a/b.py`, you can run the tests specific to that module with
+    For example, if you've fixed a bug in `allennlp_light/a/b.py`, you can run the tests specific to that module with
 
         pytest -v tests/a/b_test.py
 
     To check the code coverage locally in this example, you could run
 
-        pytest -v --cov my_package.a.b tests/a/b_test.py
+        pytest -v --cov allennlp_light.a.b tests/a/b_test.py
 
     If your contribution involves additions to any public part of the API, we require that you write docstrings
     for each function, method, class, or module that you add.
@@ -156,9 +156,9 @@ When you're ready to contribute code to address an open issue, please follow the
 
     If the build fails, it's most likely due to small formatting issues. If the error message isn't clear, feel free to comment on this in your pull request.
 
-    And finally, please update the [CHANGELOG](https://github.com/allenai/python-package-template/blob/main/CHANGELOG.md) with notes on your contribution in the "Unreleased" section at the top.
+    And finally, please update the [CHANGELOG](https://github.com/deldelmax/allennlp-light/blob/main/CHANGELOG.md) with notes on your contribution in the "Unreleased" section at the top.
 
-    After all of the above checks have passed, you can now open [a new GitHub pull request](https://github.com/allenai/python-package-template/pulls).
+    After all of the above checks have passed, you can now open [a new GitHub pull request](https://github.com/deldelmax/allennlp-light/pulls).
     Make sure you have a clear description of the problem and the solution, and include a link to relevant issues.
 
     We look forward to reviewing your PR!

LICENSE

@@ -186,16 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright {yyyy} {name of copyright owner}
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       https://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
+   Copyright 2017 The Allen Institute for Artificial Intelligence
+   Copyright 2022 Maksym Del
+   SPDX-License-Identifier: Apache-2.0
+   Adapted from https://github.com/allenai/allennlp/tree/main/allennlp

Makefile

@@ -1,12 +1,12 @@
 .PHONY : docs
 docs :
 	rm -rf docs/build/
-	sphinx-autobuild -b html --watch my_package/ docs/source/ docs/build/
+	sphinx-autobuild -b html --watch allennlp_light/ docs/source/ docs/build/
 
 .PHONY : run-checks
 run-checks :
 	isort --check .
 	black --check .
 	flake8 .
 	mypy .
-	CUDA_VISIBLE_DEVICES='' pytest -v --color=yes --doctest-modules tests/ my_package/
+	CUDA_VISIBLE_DEVICES='' pytest -v --color=yes --doctest-modules tests/ allennlp_light/