HairFastGAN icon indicating copy to clipboard operation
HairFastGAN copied to clipboard

Can you make this into an installable module

Open skyler14 opened this issue 1 year ago • 3 comments

Hello HairFastGAN Team,

First of all, thank you for your incredible work on the HairFastGAN project. It's a fascinating and valuable tool for the community.

I would like to request a feature to make HairFastGAN pip installable directly from the GitHub repository. This would greatly simplify the installation process and make it more accessible for Python developers. I believe the full steps to do this are:

Steps to Make HairFastGAN Pip Installable:

  1. Structure the Repository: Ensure the repository has a setup.py file at the root that includes all necessary package information.

  2. Create a setup.py File: This file should include the setuptools.setup() function call with necessary information like name, version, author, and most importantly, install_requires to list all dependencies.

  3. Include the requirements.txt File in setup.py: This list of all project dependencies can be referenced in the setup.py file using install_requires=open('requirements.txt').read().splitlines(). This may also be where pretrained weights are downloaded.

  4. Prepare the Package for Distribution: Use setuptools to prepare the Python package. You can use the command python setup.py sdist bdist_wheel to create a source distribution and a wheel distribution.

  5. Tag a Release: Create a tagged release in GitHub to mark a specific state of the codebase as a release. This step is important for version control and easy reference.

By following these steps, users will be able to install HairFastGAN directly from the GitHub repository using the command:

pip install git+https://github.com/AIRI-Institute/HairFastGAN

Thank you for considering this enhancement.

skyler14 avatar Apr 23 '24 12:04 skyler14