Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .codacy.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
exclude_paths:
- '{{cookiecutter.project_namespace}}/{{cookiecutter.project_slug}}/_version.py'
- 'zeroae/cli/_version.py'
- 'tests/**/*'
- 'tests/*'
- 'benchmarks/**/*'
Expand Down
6 changes: 3 additions & 3 deletions .coveragerc
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
[run]
source = {{ cookiecutter.project_namespace }}
source = zeroae

[report]
omit =
setup.py
{{ cookiecutter.project_namespace }}/{{ cookiecutter.project_slug }}/__main__.py
{{ cookiecutter.project_namespace }}/{{ cookiecutter.project_slug }}/_version.py
zeroae/cli/__main__.py
zeroae/cli/_version.py
tests/*
47 changes: 26 additions & 21 deletions .github/ght.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,34 +8,26 @@ codacy:
#
# TODO: Place your CODACY Project Id here.
# This is used for displaying your badge in public and private repos
project_id: CODACY_BADGE_TOKEN
project_id: d0799708f30942368739c3c54d4f2b92

cookiecutter:
#
# TODO: Please pick one, e.g. command_line_interface: Click
command_line_interface:
- Click
- None
command_line_interface: Click
#
# TODO: Please pick one, e.g. open_source_license: MIT
open_source_license:
- MIT
- BSD
- ISC
- Apache
- GNUv3
- Proprietary
open_source_license: MIT

#
# These were guess based on the repository information
# You probably want to customize them.
project_namespace: "{{ github.repository.full_name.split('/')[0].lower().replace(' ', '_').replace('-', '_') }}"
project_slug: "{{ github.repository.name.lower().replace(' ', '_').replace('-', '_').replace(cookiecutter.project_namespace+'_', '') }}"
project_name: "{{ cookiecutter.project_namespace }}'s {{ cookiecutter.project_slug }}"
project_namespace: "zeroae"
project_slug: "cli"
project_name: "zeroae's cli"

#
# These are likely correct...
anaconda_organization: "{{ cookiecutter.github_organization }}"
anaconda_organization: "zeroae"

#
# These should not be changed at the moment...
Expand All @@ -46,9 +38,22 @@ cookiecutter:

#
# These should probably be left alone. They came from github
full_name: "{{ github.author.name }}"
email: "{{ github.author.email }}"
github_username: "{{ github.author.username }}"
github_organization: "{{ github.repository.full_name.split('/')[0] }}"
project_repo: "{{ github.repository.name }}"
project_short_description: "{{ github.repository.description }}"
full_name: "Patrick Sodré"
email: "psodre@gmail.com"
github_username: "sodre"
github_organization: "zeroae"
project_repo: "zeroae-cli"
project_short_description: "ZeroAE's CLI"

#
# These were picked up during Initial Commit...
github:
author:
email: psodre@gmail.com
name: Patrick Sodré
username: sodre
repository:
name: zeroae-cli
full_name: zeroae/zeroae-cli
description: ZeroAE's CLI
private: false
108 changes: 0 additions & 108 deletions .github/workflows/ght-init.yml

This file was deleted.

90 changes: 0 additions & 90 deletions .github/workflows/ght-render-repo.yml

This file was deleted.

20 changes: 10 additions & 10 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Types of Contributions
Report Bugs
~~~~~~~~~~~

Report bugs at https://github.com/{{ cookiecutter.github_organization }}/{{ cookiecutter.project_repo }}/issues.
Report bugs at https://github.com/zeroae/zeroae-cli/issues.

If you are reporting a bug, please include:

Expand All @@ -38,14 +38,14 @@ and "help wanted" is open to whoever wants to implement it.
Write Documentation
~~~~~~~~~~~~~~~~~~~

{{ cookiecutter.project_name }} could always use more documentation, whether as part of the
official {{ cookiecutter.project_name }} docs, in docstrings, or even on the web in blog posts,
zeroae's cli could always use more documentation, whether as part of the
official zeroae's cli docs, in docstrings, or even on the web in blog posts,
articles, and such.

Submit Feedback
~~~~~~~~~~~~~~~

The best way to send feedback is to file an issue at https://github.com/{{ cookiecutter.github_organization }}/{{ cookiecutter.project_repo }}/issues.
The best way to send feedback is to file an issue at https://github.com/zeroae/zeroae-cli/issues.

If you are proposing a feature:

Expand All @@ -57,18 +57,18 @@ If you are proposing a feature:
Get Started!
------------

Ready to contribute? Here's how to set up `{{ cookiecutter.project_repo }}` for local development.
Ready to contribute? Here's how to set up `zeroae-cli` for local development.

1. Fork the `{{ cookiecutter.project_repo }}` repo on GitHub.
1. Fork the `zeroae-cli` repo on GitHub.
2. Clone your fork locally::

$ git clone git@github.com:your_name_here/{{ cookiecutter.project_repo }}.git
$ git clone git@github.com:your_name_here/zeroae-cli.git

3. Install your local copy into a conda environment. Assuming you have conda installed, this is how you set up your fork for local development::

$ cd {{ cookiecutter.project_repo }}/
$ cd zeroae-cli/
$ make init
$ conda activate {{ cookiecutter.project_repo }}-dev
$ conda activate zeroae-cli-dev
$ pip install -e . --no-deps

4. Create a branch for local development, use the ``f-``, ``i-`` or ``chore-`` prefixes to auto-label your PR::
Expand Down Expand Up @@ -108,7 +108,7 @@ Tips

To run a subset of tests::

$ pytest tests.test_{{ cookiecutter.project_slug }}
$ pytest tests.test_cli

Deploying
---------
Expand Down
Loading