Skip to content

Commit

Permalink
Add misc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
joowani committed Feb 8, 2021
1 parent 869afde commit 0f9cd03
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 20 deletions.
3 changes: 0 additions & 3 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
# See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v3.4.0
Expand All @@ -26,7 +24,6 @@ repos:
rev: v0.790
hooks:
- id: mypy
args: [ --no-strict-optional, --ignore-missing-imports ]
- repo: https://gitlab.com/pycqa/flake8
rev: 3.8.4
hooks:
Expand Down
2 changes: 1 addition & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
include README.md LICENSE demo.gif
include README.md LICENSE
prune tests
17 changes: 8 additions & 9 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,23 @@
# Contributing

Set up development environment:
Set up dev environment:
```shell
cd ~/your/colorpedia/clone # Activate venv if you have one (recommended)
pip install -e .[dev] # Install dev dependencies (e.g. black, mypy, pre-commit)
pre-commit install # Install git pre-commit hooks
cd ~/your/repository/fork # Activate venv if you have one (recommended)
pip install -e .[dev] # Install dev dependencies (e.g. black, mypy, pre-commit)
pre-commit install # Install git pre-commit hooks
```

Run unit tests with coverage:

```shell
py.test --cov=colorpedia --cov-report=html
py.test --cov=./ --cov-report=html # Open htmlcov/index.html in your browser
```

Build and test documentation (Colorpedia uses [MkDocs](https://www.mkdocs.org/)):
Build and test documentation (Colorpedia uses [MkDocs](https://www.mkdocs.org)):
```shell
mkdocs serve # Go to http://127.0.0.1:8000 on your browser after
mkdocs serve # Open http://127.0.0.1:8000 in your browser
```

Add new colors [here](https://github.com/joowani/colorpedia/blob/main/colorpedia/hexcodes.py)
You can add new colors [here](https://github.com/joowani/colorpedia/blob/main/colorpedia/hexcodes.py)
and palettes [here](https://github.com/joowani/colorpedia/blob/main/colorpedia/palettes.py).

Thank you for your contribution!
12 changes: 10 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,9 +1,17 @@
[build-system]
requires = ["setuptools>=42", "wheel", "setuptools_scm[toml]>=3.4"]
requires = [
"setuptools>=42",
"setuptools_scm[toml]>=3.4",
"wheel",
]
build-backend = "setuptools.build_meta"

[tool.coverage.run]
omit = ["colorpedia/cli.py", "colorpedia/setup.py"]
omit = [
"colorpedia/cli.py",
"colorpedia/version.py",
"setup.py"
]

[tool.isort]
profile = "black"
Expand Down
12 changes: 7 additions & 5 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

setup(
name="colorpedia",
description="CLI for color lookups",
description="CLI for Color Lookups",
long_description=description,
long_description_content_type="text/markdown",
author="Joohwan Oh",
Expand Down Expand Up @@ -43,12 +43,14 @@
],
},
classifiers=[
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Intended Audience :: Developers",
"License :: OSI Approved :: MIT License",
"Natural Language :: English",
"Operating System :: MacOS",
"Operating System :: Microsoft :: Windows",
"Operating System :: Unix",
"Programming Language :: Python :: 3",
"Topic :: Documentation :: Sphinx",
"Topic :: Utilities",
"License :: OSI Approved :: MIT License",
],
)

0 comments on commit 0f9cd03

Please sign in to comment.