setup.py

# Copyright 2023 The RayFed Team
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import os
from datetime import datetime

import setuptools
from setuptools import find_packages, setup

# Package and version.
BASE_VERSION = "0.1.0"
build_mode = os.getenv("RAYFED_BUILD_MODE", "")
package_name = os.getenv("RAYFED_PACKAGE_NAME", "rayfed")

if build_mode == "nightly":
    VERSION = BASE_VERSION + datetime.today().strftime("b%Y%m%d.dev0")
    package_name = "rayfed-nightly"
else:
    VERSION = BASE_VERSION + ".dev0"

this_directory = os.path.abspath(os.path.dirname(__file__))
with open(os.path.join(this_directory, 'README.md'), encoding='utf-8') as f:
    long_description = f.read()

plat_name = "any"


def read_requirements():
    requirements = []
    with open('requirements.txt') as file:
        requirements = file.read().splitlines()
    print("Requirements: ", requirements)
    return requirements


# [ref](https://github.com/perwin/pyimfit/blob/master/setup.py)
# Modified cleanup command to remove build subdirectory
# Based on: https://stackoverflow.com/questions/1710839/custom-distutils-commands
class CleanCommand(setuptools.Command):
    description = "custom clean command that forcefully removes dist/build directories"
    user_options = []

    def initialize_options(self):
        self._cwd = None

    def finalize_options(self):
        self._cwd = os.getcwd()

    def run(self):
        assert os.getcwd() == self._cwd, 'Must be in package root: %s' % self._cwd
        os.system('rm -rf ./build ./dist')


setup(
    name=package_name,
    version=VERSION,
    license='Apache 2.0',
    description=(
        'A multiple parties joint, distributed execution engine based on Ray,'
        'to help build your own federated learning frameworks in minutes.'
    ),
    long_description=long_description,
    long_description_content_type='text/markdown',
    author='RayFed Team',
    author_email='rayfed-dev@googlegroups.com',
    url='https://github.com/ray-project/rayfed',
    packages=find_packages(exclude=('examples', 'tests', 'tests.*')),
    install_requires=read_requirements(),
    extras_require={'dev': ['pylint']},
    options={'bdist_wheel': {'plat_name': plat_name}},
)