Skip to content

Commit

Permalink
Running setup script
Browse files Browse the repository at this point in the history
  • Loading branch information
jakep-allenai committed Sep 11, 2024
1 parent f141390 commit 9d43541
Show file tree
Hide file tree
Showing 21 changed files with 65 additions and 395 deletions.
44 changes: 22 additions & 22 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/allenai/tinyhost/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/allenai/tinyhost/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.
Expand All @@ -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/allenai/tinyhost/issues) to see whether your feature has already been suggested.

When creating your request, please:

Expand All @@ -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/tinyhost.git

or

git clone [email protected]:USERNAME/python-package-template.git
git clone [email protected]:USERNAME/tinyhost.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/tinyhost.git, but doesn't know anything the *main* repo, [https://github.com/allenai/tinyhost.git](https://github.com/allenai/tinyhost). 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/tinyhost.git (fetch)
origin https://github.com/USERNAME/tinyhost.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/allenai/tinyhost.git](https://github.com/allenai/tinyhost). 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/allenai/tinyhost.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/tinyhost.git (fetch)
origin https://github.com/USERNAME/tinyhost.git (push)
upstream https://github.com/allenai/tinyhost.git (fetch)
upstream https://github.com/allenai/tinyhost.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,
Expand All @@ -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 tinyhost python=3.9
conda activate tinyhost

Once your virtual environment is activated, you can install your local clone in "editable mode" with

Expand All @@ -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/allenai/tinyhost), keeping your fork up-to-date is easy:

git checkout main # if not already on main
git pull --rebase upstream main
Expand All @@ -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/allenai/tinyhost/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.
Expand All @@ -137,9 +137,9 @@ When you're ready to contribute code to address an open issue, please follow the

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/allenai/tinyhost/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 `tinyhost/a/b.py`, you can run the tests specific to that module with

pytest -v tests/a/b_test.py

Expand All @@ -152,9 +152,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/allenai/tinyhost/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/allenai/tinyhost/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!
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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/allenai/tinyhost/issues?q=is%3Aissue+sort%3Acreated-desc+).
- type: textarea
attributes:
label: 🐛 Describe the bug
Expand All @@ -17,7 +17,7 @@ body:
```python
# All necessary imports at the beginning
import my_package
import tinyhost
# A succinct reproducing example trimmed down to the essential parts:
assert False is True, "Oh no!"
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -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://tinyhost.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://tinyhost.readthedocs.io/latest is an issue.
validations:
required: true
- type: textarea
Expand Down
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ Changes proposed in this pull request:
## Before submitting

<!-- Please complete this checklist BEFORE submitting your PR to speed along the review process. -->
- [ ] I've read and followed all steps in the [Making a pull request](https://github.com/allenai/python-package-template/blob/main/.github/CONTRIBUTING.md#making-a-pull-request)
- [ ] I've read and followed all steps in the [Making a pull request](https://github.com/allenai/tinyhost/blob/main/.github/CONTRIBUTING.md#making-a-pull-request)
section of the `CONTRIBUTING` docs.
- [ ] I've updated or added any relevant docstrings following the syntax described in the
[Writing docstrings](https://github.com/allenai/python-package-template/blob/main/.github/CONTRIBUTING.md#writing-docstrings) section of the `CONTRIBUTING` docs.
[Writing docstrings](https://github.com/allenai/tinyhost/blob/main/.github/CONTRIBUTING.md#writing-docstrings) section of the `CONTRIBUTING` docs.
- [ ] If this PR fixes a bug, I've added a test that will fail without my fix.
- [ ] If this PR adds a new feature, I've added tests that sufficiently cover my new functionality.
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ jobs:
if: always()
run: |
. .venv/bin/activate
pip uninstall -y my-package
pip uninstall -y tinyhost
release:
name: Release
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/pr_checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ on:
branches:
- main
paths:
- 'my_package/**'
- 'tinyhost/**'

jobs:
changelog:
Expand Down
53 changes: 0 additions & 53 deletions .github/workflows/setup.yml

This file was deleted.

4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
.PHONY : docs
docs :
rm -rf docs/build/
sphinx-autobuild -b html --watch my_package/ docs/source/ docs/build/
sphinx-autobuild -b html --watch tinyhost/ docs/source/ docs/build/

.PHONY : run-checks
run-checks :
isort --check .
black --check .
ruff check .
mypy .
CUDA_VISIBLE_DEVICES='' pytest -v --color=yes --doctest-modules tests/ my_package/
CUDA_VISIBLE_DEVICES='' pytest -v --color=yes --doctest-modules tests/ tinyhost/

.PHONY : build
build :
Expand Down
Loading

0 comments on commit 9d43541

Please sign in to comment.