Merge branch 'release/1.0.0'

ckiplab · Jan 20, 2021 · 29b8279 · 29b8279
2 parents 56165ae + 2a4c0a2
commit 29b8279
Show file tree

Hide file tree

Showing 48 changed files with 750 additions and 64 deletions.
diff --git a/LICENSE b/LICENSE
diff --git a/Makefile b/Makefile
@@ -4,7 +4,7 @@ TWINE = twine
 TOX = tox
 LINT = pylint --rcfile=./.pylintrc
 
-.PHONY: all check dist sdist test tox tox-v tox-report lint doc upload clean
+.PHONY: all check dist sdist test tox tox-v tox-vv tox-report lint doc upload clean
 
 all: dist check test
 
@@ -21,18 +21,18 @@ lint:
 check:
 	$(TWINE) check dist/*
 
-tox tox-v tox-report:
-	( cd test ; make $@ )
+tox tox-v tox-vv tox-report:
+	( cd test && make $@ )
 
 doc:
-	( cd docs ; make clean ; make html )
+	( cd docs && make clean && make html )
 
 upload: dist check
 	ls dist/*
 	$(TWINE) upload --repository-url https://test.pypi.org/legacy/ dist/* --verbose
 
 clean:
-	- ( cd docs ; make clean )
-	- ( cd test ; make clean )
+	- ( cd docs && make clean )
+	- ( cd test && make clean )
 	- $(PY) setup.py clean -a
 	- $(RM) build dist *.egg-info __pycache__
diff --git a/README.rst b/README.rst
@@ -73,7 +73,7 @@ https://ckipnlp.readthedocs.io/
    :target: https://ckipnlp.readthedocs.io
 
 Online Demo
-^^^^^^^^^^^^^^
+^^^^^^^^^^^
 
 https://ckip.iis.sinica.edu.tw/service/corenlp
 
@@ -130,14 +130,14 @@ Installation via Pip
 Detail
 ------
 
-See https://ckipnlp.readthedocs.io/ for API details.
+See https://ckipnlp.readthedocs.io/ for full documentation.
 
 License
 -------
 
-|CC BY-NC-SA 4.0|
+|GPL-3.0|
 
-Copyright (c) 2018-2020 `CKIP Lab <https://ckip.iis.sinica.edu.tw>`__ under the `CC BY-NC-SA 4.0 License <http://creativecommons.org/licenses/by-nc-sa/4.0/>`__.
+Copyright (c) 2018-2020 `CKIP Lab <https://ckip.iis.sinica.edu.tw>`__ under the `GPL-3.0 License <https://www.gnu.org/licenses/gpl-3.0.html>`__.
 
-.. |CC BY-NC-SA 4.0| image:: https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png
-   :target: http://creativecommons.org/licenses/by-nc-sa/4.0/
+.. |GPL-3.0| image:: https://www.gnu.org/graphics/gplv3-with-text-136x68.png
+   :target: https://www.gnu.org/licenses/gpl-3.0.html
diff --git a/ckipnlp/__init__.py b/ckipnlp/__init__.py
@@ -10,9 +10,9 @@
 __copyright__ = '2018-2020 CKIP Lab'
 
 __title__ = 'CKIPNLP'
-__version__ = '0.10.0'
+__version__ = '1.0.0'
 __description__ = 'CKIP CoreNLP'
-__license__ = 'CC BY-NC-SA 4.0'
+__license__ = 'GPL-3.0'
 
 __url__ = 'https://ckipnlp.readthedocs.io'
 __download_url__ = __url__+'/tarball/'+__version__
diff --git a/ckipnlp/container/__init__.py b/ckipnlp/container/__init__.py
@@ -7,7 +7,7 @@
 
 __author__ = 'Mu Yang <http://muyang.pro>'
 __copyright__ = '2018-2020 CKIP Lab'
-__license__ = 'CC BY-NC-SA 4.0'
+__license__ = 'GPL-3.0'
 
 from .text import *
 from .seg import *

diff --git a/ckipnlp/container/base.py b/ckipnlp/container/base.py
@@ -7,7 +7,7 @@
 
 __author__ = 'Mu Yang <http://muyang.pro>'
 __copyright__ = '2018-2020 CKIP Lab'
-__license__ = 'CC BY-NC-SA 4.0'
+__license__ = 'GPL-3.0'
 
 import json as _json
 

diff --git a/ckipnlp/container/coref.py b/ckipnlp/container/coref.py
@@ -7,7 +7,7 @@
 
 __author__ = 'Mu Yang <http://muyang.pro>'
 __copyright__ = '2018-2020 CKIP Lab'
-__license__ = 'CC BY-NC-SA 4.0'
+__license__ = 'GPL-3.0'
 
 from typing import (
     NamedTuple as _NamedTuple,

diff --git a/ckipnlp/container/ner.py b/ckipnlp/container/ner.py
@@ -7,7 +7,7 @@
 
 __author__ = 'Mu Yang <http://muyang.pro>'
 __copyright__ = '2018-2020 CKIP Lab'
-__license__ = 'CC BY-NC-SA 4.0'
+__license__ = 'GPL-3.0'
 
 from typing import (
     NamedTuple as _NamedTuple,

diff --git a/ckipnlp/container/parse.py b/ckipnlp/container/parse.py
@@ -7,7 +7,7 @@
 
 __author__ = 'Mu Yang <http://muyang.pro>'
 __copyright__ = '2018-2020 CKIP Lab'
-__license__ = 'CC BY-NC-SA 4.0'
+__license__ = 'GPL-3.0'
 
 from typing import (
     NamedTuple as _NamedTuple,

diff --git a/ckipnlp/container/seg.py b/ckipnlp/container/seg.py
@@ -7,7 +7,7 @@
 
 __author__ = 'Mu Yang <http://muyang.pro>'
 __copyright__ = '2018-2020 CKIP Lab'
-__license__ = 'CC BY-NC-SA 4.0'
+__license__ = 'GPL-3.0'
 
 from .base import (
     BaseList as _BaseList,

diff --git a/ckipnlp/container/text.py b/ckipnlp/container/text.py
@@ -7,7 +7,7 @@
 
 __author__ = 'Mu Yang <http://muyang.pro>'
 __copyright__ = '2018-2020 CKIP Lab'
-__license__ = 'CC BY-NC-SA 4.0'
+__license__ = 'GPL-3.0'
 
 from .base import (
     BaseList0 as _BaseList0

diff --git a/ckipnlp/container/util/__init__.py b/ckipnlp/container/util/__init__.py
@@ -7,4 +7,4 @@
 
 __author__ = 'Mu Yang <http://muyang.pro>'
 __copyright__ = '2018-2020 CKIP Lab'
-__license__ = 'CC BY-NC-SA 4.0'
+__license__ = 'GPL-3.0'
diff --git a/ckipnlp/container/util/parse_tree.py b/ckipnlp/container/util/parse_tree.py
@@ -7,7 +7,7 @@
 
 __author__ = 'Mu Yang <http://muyang.pro>'
 __copyright__ = '2018-2020 CKIP Lab'
-__license__ = 'CC BY-NC-SA 4.0'
+__license__ = 'GPL-3.0'
 
 
 from collections import (

diff --git a/ckipnlp/container/util/wspos.py b/ckipnlp/container/util/wspos.py
@@ -7,7 +7,7 @@
 
 __author__ = 'Mu Yang <http://muyang.pro>'
 __copyright__ = '2018-2020 CKIP Lab'
-__license__ = 'CC BY-NC-SA 4.0'
+__license__ = 'GPL-3.0'
 
 from abc import (
     ABCMeta as _ABCMeta,

diff --git a/ckipnlp/data/conparse.py b/ckipnlp/data/conparse.py
@@ -5,7 +5,7 @@
 
 __author__ = 'Mu Yang <http://muyang.pro>'
 __copyright__ = '2018-2020 CKIP Lab'
-__license__ = 'CC BY-NC-SA 4.0'
+__license__ = 'GPL-3.0'
 
 ################################################################################################################################
 

diff --git a/ckipnlp/driver/__init__.py b/ckipnlp/driver/__init__.py
@@ -7,7 +7,7 @@
 
 __author__ = 'Mu Yang <http://muyang.pro>'
 __copyright__ = '2018-2020 CKIP Lab'
-__license__ = 'CC BY-NC-SA 4.0'
+__license__ = 'GPL-3.0'
 
 from .tagger import (
     CkipTaggerWordSegmenter,

diff --git a/ckipnlp/driver/base.py b/ckipnlp/driver/base.py
@@ -7,7 +7,7 @@
 
 __author__ = 'Mu Yang <http://muyang.pro>'
 __copyright__ = '2018-2020 CKIP Lab'
-__license__ = 'CC BY-NC-SA 4.0'
+__license__ = 'GPL-3.0'
 
 from abc import (
     ABCMeta as _ABCMeta,

diff --git a/ckipnlp/driver/classic.py b/ckipnlp/driver/classic.py
@@ -7,7 +7,7 @@
 
 __author__ = 'Mu Yang <http://muyang.pro>'
 __copyright__ = '2018-2020 CKIP Lab'
-__license__ = 'CC BY-NC-SA 4.0'
+__license__ = 'GPL-3.0'
 
 from abc import (
     abstractmethod as _abstractmethod,

diff --git a/ckipnlp/driver/coref.py b/ckipnlp/driver/coref.py
@@ -7,7 +7,7 @@
 
 __author__ = 'Mu Yang <http://muyang.pro>'
 __copyright__ = '2018-2020 CKIP Lab'
-__license__ = 'CC BY-NC-SA 4.0'
+__license__ = 'GPL-3.0'
 
 import numpy as _np
 

diff --git a/ckipnlp/driver/ss.py b/ckipnlp/driver/ss.py
@@ -7,7 +7,7 @@
 
 __author__ = 'Mu Yang <http://muyang.pro>'
 __copyright__ = '2018-2020 CKIP Lab'
-__license__ = 'CC BY-NC-SA 4.0'
+__license__ = 'GPL-3.0'
 
 import re as _re
 

diff --git a/ckipnlp/driver/tagger.py b/ckipnlp/driver/tagger.py
@@ -7,7 +7,7 @@
 
 __author__ = 'Mu Yang <http://muyang.pro>'
 __copyright__ = '2018-2020 CKIP Lab'
-__license__ = 'CC BY-NC-SA 4.0'
+__license__ = 'GPL-3.0'
 
 from ckipnlp.container import (
     TextParagraph as _TextParagraph,

diff --git a/ckipnlp/pipeline/__init__.py b/ckipnlp/pipeline/__init__.py
@@ -7,7 +7,7 @@
 
 __author__ = 'Mu Yang <http://muyang.pro>'
 __copyright__ = '2018-2020 CKIP Lab'
-__license__ = 'CC BY-NC-SA 4.0'
+__license__ = 'GPL-3.0'
 
 from .kernel import (
     CkipPipeline,

diff --git a/ckipnlp/pipeline/coref.py b/ckipnlp/pipeline/coref.py
@@ -7,7 +7,7 @@
 
 __author__ = 'Mu Yang <http://muyang.pro>'
 __copyright__ = '2018-2020 CKIP Lab'
-__license__ = 'CC BY-NC-SA 4.0'
+__license__ = 'GPL-3.0'
 
 from collections.abc import (
     Mapping as _Mapping,

diff --git a/ckipnlp/pipeline/kernel.py b/ckipnlp/pipeline/kernel.py
@@ -7,7 +7,7 @@
 
 __author__ = 'Mu Yang <http://muyang.pro>'
 __copyright__ = '2018-2020 CKIP Lab'
-__license__ = 'CC BY-NC-SA 4.0'
+__license__ = 'GPL-3.0'
 
 from collections.abc import (
     Mapping as _Mapping,

diff --git a/ckipnlp/util/__init__.py b/ckipnlp/util/__init__.py
@@ -7,4 +7,4 @@
 
 __author__ = 'Mu Yang <http://muyang.pro>'
 __copyright__ = '2018-2020 CKIP Lab'
-__license__ = 'CC BY-NC-SA 4.0'
+__license__ = 'GPL-3.0'
diff --git a/ckipnlp/util/data.py b/ckipnlp/util/data.py
@@ -9,7 +9,7 @@
 
 __author__ = 'Mu Yang <http://muyang.pro>'
 __copyright__ = '2018-2020 CKIP Lab'
-__license__ = 'CC BY-NC-SA 4.0'
+__license__ = 'GPL-3.0'
 
 import os as _os
 import shutil as _shutil

diff --git a/ckipnlp/util/logger.py b/ckipnlp/util/logger.py
@@ -7,7 +7,7 @@
 
 __author__ = 'Mu Yang <http://muyang.pro>'
 __copyright__ = '2018-2020 CKIP Lab'
-__license__ = 'CC BY-NC-SA 4.0'
+__license__ = 'GPL-3.0'
 
 import logging as _logging
 

diff --git a/docs/_static/custom.css b/docs/_static/custom.css
@@ -1,11 +1,26 @@
+/* header */
+
+h1 {
+	font-size: 250%;
+
+	display: inline-block;
+	border-bottom: 3px solid #2980b9;
+}
+
+/* content */
+
 .rst-content p.rubric {
-  font-size: 125%;
+	font-size: 125%;
 }
 
 .rst-content table.docutils th p {
 	margin-bottom: 0;
 }
 
+.rst-content tt.literal, .rst-content tt.literal, .rst-content code.literal {
+	color: #0057A9;
+}
+
 .wy-nav-content {
-  max-width: 1280px;
+	max-width: 1280px;
 }
diff --git a/setup.py b/setup.py
@@ -3,7 +3,7 @@
 
 __author__ = 'Mu Yang <http://muyang.pro>'
 __copyright__ = '2018-2020 CKIP Lab'
-__license__ = 'CC BY-NC-SA 4.0'
+__license__ = 'GPL-3.0'
 
 from setuptools import setup, find_namespace_packages
 import ckipnlp as about
@@ -36,7 +36,7 @@ def main():
             'Programming Language :: Python :: 3.7',
             'Programming Language :: Python :: 3.8',
             'Programming Language :: Python :: 3 :: Only',
-            'License :: Free for non-commercial use',
+            'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
             'Operating System :: POSIX :: Linux',
             'Natural Language :: Chinese (Traditional)',
         ],

diff --git a/test/Makefile b/test/Makefile
@@ -9,6 +9,9 @@ tox:
 tox-v:
 	NO_COV= $(TOX) -f py36,py37,py38 -- -v
 
+tox-vv:
+	NO_COV= $(TOX) -f py36 -- -vv
+
 tox-report:
 	- $(TOX) -p -f clean,py36,report -- --cov-append
 	python3.7 -m http.server --directory .test/htmlcov/ 3000

diff --git a/test/ext/ckip_classic/__init__.py b/test/ext/ckip_classic/__init__.py
@@ -5,4 +5,4 @@
 
 __author__ = 'Mu Yang <http://muyang.pro>'
 __copyright__ = '2018-2020 CKIP Lab'
-__license__ = 'CC BY-NC-SA 4.0'
+__license__ = 'GPL-3.0'
diff --git a/test/ext/ckip_classic/parser.py b/test/ext/ckip_classic/parser.py
@@ -5,7 +5,7 @@
 
 __author__ = 'Mu Yang <http://muyang.pro>'
 __copyright__ = '2018-2020 CKIP Lab'
-__license__ = 'CC BY-NC-SA 4.0'
+__license__ = 'GPL-3.0'
 
 import numpy as np
 

diff --git a/test/ext/ckip_classic/ws.py b/test/ext/ckip_classic/ws.py
@@ -5,7 +5,7 @@
 
 __author__ = 'Mu Yang <http://muyang.pro>'
 __copyright__ = '2018-2020 CKIP Lab'
-__license__ = 'CC BY-NC-SA 4.0'
+__license__ = 'GPL-3.0'
 
 import numpy as np
 

diff --git a/test/ext/ckiptagger/__init__.py b/test/ext/ckiptagger/__init__.py
@@ -5,7 +5,7 @@
 
 __author__ = 'Mu Yang <http://muyang.pro>'
 __copyright__ = '2018-2020 CKIP Lab'
-__license__ = 'CC BY-NC-SA 4.0'
+__license__ = 'GPL-3.0'
 
 import numpy as np
 

diff --git a/test/script/container/_base.py b/test/script/container/_base.py
@@ -3,7 +3,7 @@
 
 __author__ = 'Mu Yang <http://muyang.pro>'
 __copyright__ = '2018-2020 CKIP Lab'
-__license__ = 'CC BY-NC-SA 4.0'
+__license__ = 'GPL-3.0'
 
 import abc
 import json

diff --git a/test/script/container/test_coref.py b/test/script/container/test_coref.py
@@ -3,7 +3,7 @@
 
 __author__ = 'Mu Yang <http://muyang.pro>'
 __copyright__ = '2018-2020 CKIP Lab'
-__license__ = 'CC BY-NC-SA 4.0'
+__license__ = 'GPL-3.0'
 
 from _base import _TestBase
 from ckipnlp.container.coref import *

diff --git a/test/script/container/test_ner.py b/test/script/container/test_ner.py
@@ -3,7 +3,7 @@
 
 __author__ = 'Mu Yang <http://muyang.pro>'
 __copyright__ = '2018-2020 CKIP Lab'
-__license__ = 'CC BY-NC-SA 4.0'
+__license__ = 'GPL-3.0'
 
 from _base import _TestBase
 from ckipnlp.container.ner import *