Makefile

# later on we would write this
# Copyright (C) 2017 - 0000 KoNLTK project
#
# Korean Natural Language Toolkit: source Makefile
#
# Author: HyunYoung Lee <hyun02.engineer@gmail.com>
#         GyuHyeon Nam <ngh3053@gmail.com>
#         Seungshik Kang <sskang@kookmin.ac.kr>
# URL: <https://www.konltk.org>
# For license information, see LICENSE.TXT
# ========================================================

# Deployment instructions
# 0. Fill in `pypirc.sample`, and `cp pypirc.sample ~/.pypirc`
#
# 1. Check version as konlp/VERSION
# 2. $ make testpypi
# 3. $ make pypi # notice that you don't change the version number. 
# 4. Push tag 
# 5. updat the document

# TODO: how to use pylint 
 
PYTHON = python
PIP = pip
PACKAGE = konlp

# Before making release 
# without pyroma,
#
# pip install pyroma 
#
# if you make the distribution of source
# change the command below to "$ pyroma dist/konlp-*.tar.gz"
# If you know about pyroma, visit https://pypi.org/project/pyroma/
# If you distribute source file,  use check-manifest
# without check-manifest
# 
# pip install check-manifest
# 
# If you know about how to use check-manifest,
# visit https://pypi.org/project/check-manifest/
#
# In order to inspect the quality of the code to PEP8
# Use pylint with configuration file 
# How to use pylint, visit here https://github.com/PyCQA/pylint
# http://pylint.pycqa.org/en/latest/user_guide/run.html?highlight=rcfile
# https://github.com/PyCQA/pylint/blob/master/pylintrc 
#
# sdist, check PEP0440 - how to number release version
# https://www.python.org/dev/peps/pep-0440/#pre-releases
##################################################################
#                                                                #
#                             Check                              #
#                                                                #
##################################################################
sdist:
	$(PYTHON) setup.py sdist --format=gztar,zip

check:	sdist
	check-manifest -u -v
	pyroma dist/konlp-*.tar.gz
	pyroma dist/konlp-*.zip
#	rm -rf dist
#	rm -rf konlp.egg-info

# Later on, we have to change the command below to use  the configuration file 
code_check:
	pylint konlp/*


# Before use testpypi and pypi, update pypirc.sample to $HOME/USERNAME/.pypir
# Then check the version 
# 
#   twine 1.8.0
#   setuptools 27.0.0
#   Python 2.7.13 (distutils update)
#   Python 3.4.6 (distutils update)
#   Python 3.5.3 (distutils update)
#   Python 3.6.0 (distutils update)
#
# https://packaging.python.org/guides/migrating-to-pypi-org/
# If you want to distribute sorce 
# --format option you can also one of zip and gztar.
# If you want to use zip, --format=zip OR if gztar, --format=gztar


##################################################################
#                                                                #
#                            testpypi                            #
#                                                                #
##################################################################

# If you want to use another way, use the command below
# Reference : https://packaging.python.org/guides/using-testpypi/#using-test-pypi
#           : https://packaging.python.org/tutorials/distributing-packages/#uploading-your-project-to-pypi
# python setup.py bdist_wheel
# twine upload --repository-url https://test.pypi.org/legacy/ dist/*

testpypi:
	$(PYTHON) setup.py register -r testpypi
	#$(PYTHON) setup.py sdist --format=gztar upload -r testpypi
	$(PYTHON) setup.py bdist_wheel upload -r testpypi
	# Execute manually below 
	# If you don't have the virtualenv, pip install virtualenv
	# cd /tmp
	# virtualenv venv
	# source venv/bin/activate
	# pip install --index-url https://test.pypi.org/simple/ konlp
	# deactivate 
	# virtualenv-3.5 venv3
	# source venv3/bin/activate
	# pip3 install --index-url https://test.pypi.org/simple/ konlp


##################################################################
#                                                                #
#                              pypi                              #
#                                                                #
##################################################################

# If you want to use another way, use the command below
# Reference : https://packaging.python.org/guides/using-testpypi/#using-test-pypi
#           : https://packaging.python.org/tutorials/distributing-packages/#uploading-your-project-to-pypi
# python setup.py bdist_wheel
# twine upload dist/*

pypi:
	$(PYTHON) setup.py register -r pypi
	#$(PYTHON) setup.py sdist --format=gztar upload -r pypi
	$(PYTHON) setup.py bdist_wheel upload -r pypi

clean:
	rm -rf build
	rm -rf dist
	rm -rf konlp.egg-info

#clean_code:
#	rm -f `find konlp -name '*.pyc'`
#	rm -f `find konlp -name '*.pyo'`