Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

HARMONY-388: Better consistency across Python repos #13

Merged
merged 11 commits into from
Jun 8, 2021
Merged

HARMONY-388: Better consistency across Python repos #13

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
664ac3d
HARMONY-388: Make additional recommendation on Python environment setup
vinnyinverso May 21, 2021
e4ba0c0
HARMONY-388: Update faker version to fix PosixPath keyerror
vinnyinverso May 24, 2021
1da6465
HARMONY-388: Consistent name of makefile
vinnyinverso May 28, 2021
3a05f23
HARMONY-388: Make manifest files consistent
vinnyinverso Jun 1, 2021
0488290
HARMONY-388: Use consistent naming in make targets
vinnyinverso Jun 1, 2021
acae574
HARMONY-388: Update reference to develop target in make file
vinnyinverso Jun 1, 2021
3d27a9c
HARMONY-388: Update reference to develop target in GH action
vinnyinverso Jun 1, 2021
5603966
HARMONY-388: Point to consolidated virtual environment guidance
vinnyinverso Jun 2, 2021
cee88a3
HARMONY-388: Remove period
vinnyinverso Jun 2, 2021
9bd50b7
HARMONY-388: Move ignore lines to consistent place (customizations to…
vinnyinverso Jun 2, 2021
fdb5f92
HARMONY-388: Remove ENVHELP.md
vinnyinverso Jun 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
python-version: ${{ matrix.python-version }}

- name: Install dependencies
run: make develop
run: make install

- name: CVE Checks
run: make cve-check
Expand Down
16 changes: 8 additions & 8 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
# Temporary output directories
tmp*
.DS_Store
tmp
config-*.json
config.json

# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
Expand Down Expand Up @@ -128,4 +121,11 @@ venv.bak/
dmypy.json

# Pyre type checker
.pyre/
.pyre/

# Temporary output directories
tmp*
.DS_Store
tmp
config-*.json
config.json
11 changes: 8 additions & 3 deletions MANIFEST.in
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# Things to include in the built package (besides the packages defined in setup.py)
include README.md
include LICENSE
# Include the README, et. al.
include *.md

# Include the license file
include LICENSE

# Include setup.py
include setup.py
4 changes: 2 additions & 2 deletions makefile → Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.PHONY: clean build publish test develop
.PHONY: clean build publish test install

VERSION ?= $(shell git describe --tags | sed 's/-/\+/' | sed 's/-/\./g')
REPO ?= https://upload.pypi.org/legacy/
Expand All @@ -19,7 +19,7 @@ publish: build
clean:
rm -rf build dist *.egg-info || true

develop:
install:
pip install -e .[dev]

lint:
Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,12 +104,12 @@ OPTIONAL -- Use with CAUTION:
## Development Setup

Prerequisites:
- Python 3.7+, ideally installed via a virtual environment such as `pyenv`
- Python 3.7+, ideally installed via a [virtual environment](https://github.com/nasa/harmony-service-example/blob/main/ENVHELP.md)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small nit (that I'm not even sure I'm right about): I'm on the fence about whether we should link across repos like this, but if we do, we should probably link in the direction of our dependency arrows. harmony-service-example depends on this repo, so the ENVHELP.md should go in this repo with harmony-service-example pointing to it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, it does feel kinda weird. I think I'll remove it.

- A local copy of the code

Install dependencies:

$ make develop
$ make install

Run linter against production code:

Expand Down
2 changes: 1 addition & 1 deletion dev-requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
autopep8 ~= 1.5
debugpy ~= 1.2
Faker ~= 6.0
Faker ~= 8.1.3
flake8 ~= 3.8
ipython ~= 7.17
jedi ~= 0.17.2
Expand Down