Skip to content

Commit

Permalink
Merge pull request #1 from linkml/customization
Browse files Browse the repository at this point in the history
customization
  • Loading branch information
cmungall committed Sep 9, 2022
2 parents ef97127 + 4589d18 commit deab1a3
Show file tree
Hide file tree
Showing 9 changed files with 277 additions and 175 deletions.
7 changes: 5 additions & 2 deletions cookiecutter.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
{
"project_name": "Project_X",
"project_name": "my-awesome-schema",
"__project_slug": "{{ cookiecutter.project_name|lower()|replace(' ', '_')|replace('-', '_') }}",
"github_org": "my-org",
"project_description": "This is the project description.",
"author": "Harshad Hegde <hhegde@lbl.gov>",
"github_token_for_pypi_deployment": "PYPI_PASSWORD"
"main_schema_class": "Person",
"create_python_classes": "Yes/No",
"github_token_for_pypi_deployment": "PYPI_PASSWORD (leave blank if not a python project)"
}
2 changes: 1 addition & 1 deletion {{cookiecutter.project_name}}/.gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
docs/
./docs/

# Byte-compiled / optimized / DLL files
__pycache__/
Expand Down
4 changes: 4 additions & 0 deletions {{cookiecutter.project_name}}/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ help: status
@echo "make install -- install dependencies"
@echo "make setup -- initial setup"
@echo "make test -- runs tests"
@echo "make lint -- perfom linting"
@echo "make testdoc -- builds docs and runs local test server"
@echo "make deploy -- deploys site"
@echo "make update -- updates linkml version"
Expand Down Expand Up @@ -51,6 +52,9 @@ gen-project: $(PYMODEL)
test:
$(RUN) gen-project -d tmp $(SOURCE_SCHEMA_PATH)

lint:
$(RUN) linkml-lint $(SOURCE_SCHEMA_PATH)

check-config:
@(grep my-datamodel about.yaml > /dev/null && printf "\n**Project not configured**:\n\n - Remember to edit 'about.yaml'\n\n" || exit 0)

Expand Down
18 changes: 17 additions & 1 deletion {{cookiecutter.project_name}}/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
# {{cookiecutter.__project_slug}}
# {{cookiecutter.project_name}}

{{cookiecutter.project_description}}

## Website

* [https://{{cookiecutter.github_org}}.github.io/{{cookiecutter.project_name}}](https://{{cookiecutter.github_org}}.github.io/{{cookiecutter.project_name}})

## Developer Documentation

<details>
Use the `make` command to generate project artefacts:

- `make all`: make everything
- `make deploy`: deploys site

</details>

## Credits

this project was made with [linkml-project-cookiecutter](https://github.com/linkml/linkml-project-cookiecutter)
20 changes: 4 additions & 16 deletions {{cookiecutter.project_name}}/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
site_name: "My Datamodel"
site_name: "{{cookiecutter.project_name}}"
theme:
name: material
analytics:
Expand All @@ -10,22 +10,10 @@ theme:
- content.tabs.link
plugins:
- search
markdown_extensions:
- pymdownx.highlight: