setup.py 3.01 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
"""
Simple check list from AllenNLP repo: https://github.com/allenai/allennlp/blob/master/setup.py

To create the package for pypi.

1. Change the version in __init__.py and setup.py.

2. Commit these changes with the message: "Release: VERSION"

3. Add a tag in git to mark the release: "git tag VERSION -m'Adds tag VERSION for pypi' "
   Push the tag to git: git push --tags origin master

4. Build both the sources and the wheel. Do not change anything in setup.py between
   creating the wheel and the source distribution (obviously).

   For the wheel, run: "python setup.py bdist_wheel" in the top level allennlp directory.
   (this will build a wheel for the python version you use to build it - make sure you use python 3.x).

   For the sources, run: "python setup.py sdist"
   You should now have a /dist directory with both .whl and .tar.gz source versions of allennlp.

5. Check that everything looks correct by uploading the package to the pypi test server:

   twine upload dist/* -r pypitest
   (pypi suggest using twine as other methods upload files via plaintext.)

   Check that you can install it in a virtualenv by running:
thomwolf's avatar
typos  
thomwolf committed
28
   pip install -i https://testpypi.python.org/pypi pytorch-transformers
29
30
31
32
33
34
35

6. Upload the final version to actual pypi:
   twine upload dist/* -r pypi

7. Copy the release notes from RELEASE.md to the tag in github once everything is looking hunky-dory.

"""
thomwolf's avatar
thomwolf committed
36
from io import open
thomwolf's avatar
thomwolf committed
37
38
39
from setuptools import find_packages, setup

setup(
thomwolf's avatar
thomwolf committed
40
    name="pytorch_transformers",
LysandreJik's avatar
LysandreJik committed
41
42
    version="1.1.0",
    author="Thomas Wolf, Lysandre Debut, Victor Sanh, Julien Chaumond, Google AI Language Team Authors, Open AI team Authors",
thomwolf's avatar
thomwolf committed
43
    author_email="thomas@huggingface.co",
LysandreJik's avatar
LysandreJik committed
44
    description="Repository of pre-trained NLP Transformer models: BERT & RoBERTa, GPT & GPT-2, Transformer-XL, XLNet and XLM",
45
    long_description=open("README.md", "r", encoding='utf-8').read(),
thomwolf's avatar
thomwolf committed
46
    long_description_content_type="text/markdown",
thomwolf's avatar
thomwolf committed
47
    keywords='NLP deep learning transformer pytorch BERT GPT GPT-2 google openai CMU',
thomwolf's avatar
thomwolf committed
48
    license='Apache',
thomwolf's avatar
thomwolf committed
49
    url="https://github.com/huggingface/pytorch-transformers",
thomwolf's avatar
thomwolf committed
50
51
    packages=find_packages(exclude=["*.tests", "*.tests.*",
                                    "tests.*", "tests"]),
52
    install_requires=['torch>=1.0.0',
thomwolf's avatar
thomwolf committed
53
                      'numpy',
thomwolf's avatar
thomwolf committed
54
                      'boto3',
thomwolf's avatar
thomwolf committed
55
                      'requests',
56
                      'tqdm',
thomwolf's avatar
thomwolf committed
57
                      'regex',
58
                      'sentencepiece',
Shijie Wu's avatar
Shijie Wu committed
59
60
61
62
63
                      'sacremoses',
                      'pythainlp',
                      'kytea',
                      'nltk',
                      'jieba'],
64
65
    entry_points={
      'console_scripts': [
thomwolf's avatar
thomwolf committed
66
        "pytorch_transformers=pytorch_transformers.__main__:main",
67
68
      ]
    },
thomwolf's avatar
thomwolf committed
69
    # python_requires='>=3.5.0',
thomwolf's avatar
thomwolf committed
70
71
72
73
74
75
76
77
    tests_require=['pytest'],
    classifiers=[
          'Intended Audience :: Science/Research',
          'License :: OSI Approved :: Apache Software License',
          'Programming Language :: Python :: 3',
          'Topic :: Scientific/Engineering :: Artificial Intelligence',
    ],
)