add setup.py, .travis.yml, .coveralls.yml

.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

.travis.yml

@@ -0,0 +1,34 @@
+language: python
+python:
+  - "3.6"
+  - "3.7"
+  - "3.8"
+
+# base operating system for online CI, 'trusty' not work for python3.8
+dist: xenial
+sudo: false
+
+# Cache allows for a Python package versions to be
+# stored between runtime, to speed up sequential builds
+cache: pip
+
+install:
+  - pip install -r requirements.txt
+  - pip install coveralls
+  - pip install coverage
+
+script: true  # trying to add real test script
+
+## command to run tests
+# script:
+#   coverage run --source=fedlab_core setup.py test
+# after_success:
+#   coveralls
+
+notifications:
+  email:
+    recipients:
+      - zszxlsq@gmail.com
+      - zengdun.cs@gmail.com
+    on_success: never
+    on_failure: always    # send a notification when build fail

requirements.txt

@@ -1,70 +1,2 @@
-argon2-cffi @ file:///tmp/build/80754af9/argon2-cffi_1596828452693/work
-async-generator==1.10
-attrs @ file:///tmp/build/80754af9/attrs_1604765588209/work
-autopep8==1.5.4
-backcall==0.2.0
-bleach @ file:///tmp/build/80754af9/bleach_1600439572647/work
-certifi==2020.12.5
-cffi @ file:///tmp/build/80754af9/cffi_1606255099073/work
-cycler==0.10.0
-decorator==4.4.2
-defusedxml==0.6.0
-entrypoints==0.3
-flake8==3.8.4
-importlib-metadata @ file:///tmp/build/80754af9/importlib-metadata_1602276842396/work
-ipykernel @ file:///tmp/build/80754af9/ipykernel_1596206598566/work/dist/ipykernel-5.3.4-py3-none-any.whl
-ipython @ file:///tmp/build/80754af9/ipython_1604101195213/work
-ipython-genutils @ file:///tmp/build/80754af9/ipython_genutils_1606773439826/work
-ipywidgets @ file:///tmp/build/80754af9/ipywidgets_1601490159889/work
-jedi==0.17.0
-Jinja2==2.11.2
-jsonschema @ file:///tmp/build/80754af9/jsonschema_1602607155483/work
-jupyter==1.0.0
-jupyter-client @ file:///tmp/build/80754af9/jupyter_client_1601311786391/work
-jupyter-console @ file:///tmp/build/80754af9/jupyter_console_1598884538475/work
-jupyter-core @ file:///tmp/build/80754af9/jupyter_core_1606148959479/work
-jupyterlab-pygments @ file:///tmp/build/80754af9/jupyterlab_pygments_1601490720602/work
-kiwisolver==1.3.1
-MarkupSafe @ file:///tmp/build/80754af9/markupsafe_1594371495811/work
-matplotlib==3.3.3
-mccabe==0.6.1
-mistune @ file:///tmp/build/80754af9/mistune_1594373098390/work
-nbclient @ file:///tmp/build/80754af9/nbclient_1602783176460/work
-nbconvert @ file:///tmp/build/80754af9/nbconvert_1601914821128/work
-nbformat @ file:///tmp/build/80754af9/nbformat_1602783287752/work
-nest-asyncio @ file:///tmp/build/80754af9/nest-asyncio_1606153767164/work
-notebook @ file:///tmp/build/80754af9/notebook_1607976307905/work
-numpy==1.19.4
-packaging @ file:///tmp/build/80754af9/packaging_1607971725249/work
-pandocfilters @ file:///tmp/build/80754af9/pandocfilters_1605120451932/work
-parso @ file:///tmp/build/80754af9/parso_1607623074025/work
-pexpect @ file:///tmp/build/80754af9/pexpect_1605563209008/work
-pickleshare @ file:///tmp/build/80754af9/pickleshare_1606932040724/work
-Pillow==8.0.1
-prometheus-client @ file:///tmp/build/80754af9/prometheus_client_1606344362066/work
-prompt-toolkit @ file:///tmp/build/80754af9/prompt-toolkit_1602688806899/work
-ptyprocess @ file:///tmp/build/80754af9/ptyprocess_1605560620615/work/dist/ptyprocess-0.6.0-py2.py3-none-any.whl
-pycodestyle==2.6.0
-pycparser @ file:///tmp/build/80754af9/pycparser_1594388511720/work
-pyflakes==2.2.0
-Pygments @ file:///tmp/build/80754af9/pygments_1607368905949/work
-pyparsing==2.4.7
-pyrsistent @ file:///tmp/build/80754af9/pyrsistent_1600141707582/work
-python-dateutil==2.8.1
-pyzmq==20.0.0
-qtconsole @ file:///tmp/build/80754af9/qtconsole_1600870028330/work
-QtPy==1.9.0
-Send2Trash @ file:///tmp/build/80754af9/send2trash_1607525499227/work
-six @ file:///tmp/build/80754af9/six_1605205313296/work
-terminado==0.9.1
-testpath==0.4.4
-toml==0.10.2
-torch==1.7.1
-torchvision==0.8.2
-tornado @ file:///tmp/build/80754af9/tornado_1606942283357/work
-traitlets @ file:///tmp/build/80754af9/traitlets_1602787416690/work
-typing-extensions==3.7.4.3
-wcwidth @ file:///tmp/build/80754af9/wcwidth_1593447189090/work
-webencodings==0.5.1
-widgetsnbextension==3.5.1
-zipp @ file:///tmp/build/80754af9/zipp_1604001098328/work
+torch
+torchvision

setup.py

@@ -0,0 +1,50 @@
+# -*- coding: utf-8 -*-
+# @Time    : 3/19/21 4:13 PM
+# @Author  : Siqi Liang
+# @Contact : zszxlsq@gmail.com
+# @File    : setup.py
+# @Software: PyCharm
+from setuptools import setup, find_packages
+from codecs import open
+from os import path
+
+
+def get_readme():
+    here = path.abspath(path.dirname(__file__))
+
+    # Get the long description from the README file
+    with open(path.join(here, 'README.md'), encoding='utf-8') as f:
+        long_description = f.read()
+    return long_description
+
+
+setup(
+    name="DocsExp",
+    version="0.1",
+    author="Dun Zeng, Siqi Liang",
+    author_email="zengdun.cs@gmail.com, zszxlsq@gmail.com",
+    description="A framework for simulation in federated setting implemented in PyTorch",
+    long_description=get_readme(),
+    url="https://github.com/Zengdun-cs/FedLab",
+    packages=find_packages(exclude=['docs']),  # TODO: add things in 'exclude'
+    install_requires=['torch',
+                      'torchvision',
+                      'numpy'],
+    python_requires='>=3.6',
+    classifiers=[
+        'Intended Audience :: Research',
+
+        'Topic :: Scientific/Engineering',
+        'Topic :: Scientific/Engineering :: Artificial Intelligence',
+        'Topic :: Software Development',
+        'Topic :: Software Development :: Libraries',
+        'Topic :: Software Development :: Libraries :: Python Modules',
+
+        'License :: OSI Approved :: MIT License',  # TODO: is MIT proper???
+
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
+    ],
+    # test_suite="tests.get_tests"
+)