Skip to content

Add initial dev setup automation #231

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

Merged
merged 11 commits into from
May 5, 2022
Merged

Add initial dev setup automation #231

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
534a6a6
add makefile to automate setup
fpliger May 5, 2022
9e753e2
Update pyscriptjs/Makefile
fpliger May 5, 2022
7ba5dc2
Update pyscriptjs/Makefile
fpliger May 5, 2022
ce19ae6
fix env typo
fpliger May 5, 2022
3dc4d44
Merge branch 'fpliger/69_add_makefile' of github.com:anaconda/pyscrip…
fpliger May 5, 2022
769cc28
move setup to top per PR comments
fpliger May 5, 2022
22e6e14
improve makefile and add python dev enviroment requirements file
fpliger May 5, 2022
0810acd
Merge branch 'main' into fpliger/69_add_makefile
fpliger May 5, 2022
93b539d
add pre-commit-config file
fpliger May 5, 2022
f9d2c5e
Update pyscriptjs/Makefile
fpliger May 5, 2022
88e15f8
fix EOF
fpliger May 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# This is the configuration for pre-commit, a local framework for managing pre-commit hooks
# Check out the docs at: https://pre-commit.com/

repos: []
84 changes: 84 additions & 0 deletions pyscriptjs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
tag := latest
git_hash ?= $(shell git log -1 --pretty=format:%h)

base_dir ?= $(shell git rev-parse --show-toplevel)
src_dir ?= $(base_dir)/src
examples ?= $(base_dir)/examples
app_dir ?= $(shell git rev-parse --show-prefix)

CONDA_ENV ?= ./env
env := $(CONDA_ENV)
conda_run := conda run -p $(env)

.PHONY: setup
setup:
@if [ -z "$${CONDA_SHLVL:+x}" ]; then echo "Conda is not installed." && exit 1; fi
$(CONDA_EXE) env $(shell [ -d $(env) ] && echo update || echo create) -p $(env) --file environment.yml

.PHONY: clean
clean:
find . -name \*.py[cod] -delete
rm -rf .pytest_cache .coverage coverage.xml

clean-all: clean
rm -rf $(env) *.egg-info

.PHONY: shell
shell:
@export CONDA_ENV_PROMPT='<{name}>'
@echo 'conda activate $(env)'
Copy link
Contributor

Choose a reason for hiding this comment

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

I have been unable to coerce this into working in other repos. As-is, this is a no-op echo.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure if you are + or - on this one :D

This specific cmd is not that relevant anymore(and I think I'll remove it) no that we want to default using conda run... right? Or am I missing something?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, I was indirectly suggesting we remove it, unless you have a way to make it work :)


.PHONY: dev
dev:
npm run dev

.PHONY: build
build:
npm run build

.PHONY: test
test:
@echo "Tests are coming :( this is a placeholder and it's meant to fail!"
$(conda_run) pytest -vv $(ARGS) tests/ --log-cli-level=warning

.PHONY: test-py
test-py:
@echo "Tests are coming :( this is a placeholder and it's meant to fail!"
$(conda_run) pytest -vv $(ARGS) tests/ --log-cli-level=warning

.PHONY: test-ts
test-ts:
@echo "Tests are coming :( this is a placeholder and it's meant to fail!"
npm run tests

.PHONY: fmt
fmt: fmt-py fmt-ts
@echo "Format completed"

.PHONY: fmt-check
fmt-check: fmt-ts-check fmt-py
@echo "Format check completed"

.PHONY: fmt-ts
fmt-ts:
npm run format

.PHONY: fmt-ts-check
fmt-ts-check:
npm run format:check

.PHONY: fmt-py
fmt-py:
$(conda_run) black -l 88 .

.PHONY: fmt-py-check
fmt-py-check:
$(conda_run) black -l 88 --check .

.PHONY: lint
lint: lint-ts
@echo "Format check completed"

.PHONY: lint-ts
lint-ts:
$(conda_run) npm run lint
11 changes: 11 additions & 0 deletions pyscriptjs/environment.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
channels:
- defaults
- conda-forge
dependencies:
- python=3.9
- pip=20.2.2
- pytest=7
- nodejs=16
- black
- isort
- codespell