Skip to content

Commit

Permalink
Add full CLI support
Browse files Browse the repository at this point in the history
This commit ..
* Improves scripts
* Updates dependencies
* Supercharges .gitignore
* Migrates it into an installable CLI utility

.. and fixes #8
  • Loading branch information
S1SYPHOS committed Aug 18, 2021
1 parent 73e10c2 commit eb7e4c5
Show file tree
Hide file tree
Showing 14 changed files with 305 additions and 109 deletions.
135 changes: 135 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,9 +1,144 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff
instance/
.webassets-cache

# Scrapy stuff
.scrapy

# VSCode stuff
.vscode

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# PEP 582; used by e.g. github.com/David-OConnor/pyflow
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

# Gotta fetch 'em all!
/palettes/*/**/*
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ It's as easy as `pip install -r requirements.txt`, but you might want to make su
Fetching color sets and processing them is really straightforward - for everything else, there's `--help`:

```bash
$ python main.py
Usage: main.py [OPTIONS] COMMAND [ARGS]...
$ colors
Usage: colors [OPTIONS] COMMAND [ARGS]...

Options:
-v, --version Show the version and exit.
Expand All @@ -51,10 +51,10 @@ Using its commands `fetch` and `process` is fairly easy, like that:

```bash
# Example 1 - Gotta fetch 'em `--all`:
$ python main.py fetch --all && python main.py process
$ colors fetch --all && colors process

# Example 2 - Fetching specific sets & processing them:
$ python main.py fetch copic dulux && python main.py process copic dulux
$ colors fetch copic dulux && colors process copic dulux
```

### FAQ
Expand Down
9 changes: 5 additions & 4 deletions examples.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,13 @@
# For more information, see https://www.python.org/dev/peps/pep-0008/#imports
##

import os
import glob
from os import system
from os.path import basename, dirname
from glob import glob


for file in glob.glob('./examples/*/index.php'):
for file in glob('./examples/*/index.php'):
html = file.replace('.php', '.html')
os.system('cd ' + os.path.dirname(file) + ' && php ' + os.path.basename(file) + ' > ' + os.path.basename(html))
system('cd ' + dirname(file) + ' && php ' + basename(file) + ' > ' + basename(html))

print('Generating ' + html + ' .. done')
93 changes: 0 additions & 93 deletions main.py

This file was deleted.

46 changes: 46 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# ~*~ coding=utf-8 ~*~

import io
from os.path import abspath, dirname, join
from setuptools import find_packages, setup


VERSION = '1.0.0'


def long_description():
readme_file = join(dirname(abspath(__file__)), 'README.md')

with io.open(readme_file, encoding='utf8') as file:
return file.read()


setup(
name='we-love-colors',
description='PANTONE®, RAL®, Dulux®, Copic® and Prismacolor® color palettes for Scribus, GIMP & Inkscape, the Python way',
long_description=long_description(),
long_description_content_type='text/markdown',
version=VERSION,
license='MIT',
author='Martin Folkers',
author_email='[email protected]',
maintainer='Fundevogel',
maintainer_email='[email protected]',
url='https://github.com/Fundevogel/we-love-colors',
project_urls={
"Source code": "https://github.com/Fundevogel/we-love-colors",
"Issues": "https://github.com/Fundevogel/we-love-colors/issues",
},
packages=find_packages(),
install_requires=[
'bs4',
'click',
'lxml',
'pillow',
],
entry_points='''
[console_scripts]
colors=we_love_colors.cli:cli
''',
python_requires='>=3.5',
)
21 changes: 19 additions & 2 deletions setup.sh
Original file line number Diff line number Diff line change
@@ -1,4 +1,21 @@
#!/bin/bash

# Setting up virtualenv & installing dependencies from `requirements.txt`
virtualenv -p python3 .env && source .env/bin/activate && pip install -r requirements.txt
# Setting up & activating virtualenv
virtualenv -p python3 .env
# shellcheck disable=SC1091
source .env/bin/activate

# Installing dependencies
pip install --editable .

# Creating directory structure
cd palettes || exit

for dir in copic \
dulux \
pantone \
prismacolor \
ral
do
mkdir -p "$dir"
done
Loading

0 comments on commit eb7e4c5

Please sign in to comment.