Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Can you make this into an installable module #6

Open
skyler14 opened this issue Apr 23, 2024 · 3 comments
Open

Can you make this into an installable module #6

skyler14 opened this issue Apr 23, 2024 · 3 comments

Comments

@skyler14
Copy link

skyler14 commented Apr 23, 2024

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.

@gloompi
Copy link

gloompi commented Jun 6, 2024

any progress here?

@maximkm
Copy link
Contributor

maximkm commented Jun 11, 2024

Hello, at the moment we are getting an error when building dlib library from requirements. We will solve it and make an installable module later.

@gloompi
Copy link

gloompi commented Jun 17, 2024

@maximkm thanks for letting us know. What is the priority of making it installable? How long do you think it might take? We would be very happy to use it in our project, but not being able to install it makes it hard for us.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants