From 0f9cd035d1eeef64586faa23f020fcc2b5b5a009 Mon Sep 17 00:00:00 2001 From: Joohwan Oh Date: Mon, 8 Feb 2021 01:11:24 -0800 Subject: [PATCH] Add misc updates --- .pre-commit-config.yaml | 3 --- MANIFEST.in | 2 +- docs/CONTRIBUTING.md | 17 ++++++++--------- pyproject.toml | 12 ++++++++++-- setup.py | 12 +++++++----- 5 files changed, 26 insertions(+), 20 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 0d143c5..a79ea88 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -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 @@ -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: diff --git a/MANIFEST.in b/MANIFEST.in index beea33c..8815dcc 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,2 +1,2 @@ -include README.md LICENSE demo.gif +include README.md LICENSE prune tests diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index e9cb7eb..be7570b 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -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! diff --git a/pyproject.toml b/pyproject.toml index 77561a6..1553b7c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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" diff --git a/setup.py b/setup.py index 578c559..3266415 100644 --- a/setup.py +++ b/setup.py @@ -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", @@ -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", ], )