forbaokhanh / dermscan

Python script that scans a list of input ingredients and compares them to those known to cause pore clogging

🧴🎀 dermscan

Comedogenic Skincare Analysis Tool

Welcome to Dermscan 🧴, the command-line interface (CLI) tool designed to revolutionize the way you interact with skincare products. By analyzing ingredient lists against comprehensive dermatological databases, Dermscan empowers users to make informed decisions about their skincare choices, ensuring compatibility and safety for all skin types.

🌈 Features

• 🔍 Ingredient Analysis: Input your product's ingredients, and Dermscan will provide an in-depth analysis, highlighting potential skin irritants or comedogenic substances that might clog pores and cause breakouts.

• 📊 Detailed Reports: Receive comprehensive reports on ingredient safety, efficacy, and scientific backing directly in your terminal.

• 🔖 Easy Integration: Seamlessly integrate with existing skincare apps and platforms through well-documented APIs.

🛠 Installation

To get started with Dermscan, clone this repository and navigate to the project directory:

git clone https://github.com/forbaokhanh/dermscan.git
cd dermscan

Use the provided Makefile for an easy setup:

make install

🚀 Usage

Running Dermscan is as simple as executing the main.py script from your command line:

python dermscan/main.py

Follow the on-screen prompts to enter your ingredients or upload a file with ingredient details.

📚 Documentation

For more detailed information on commands and configurations, refer to the docs folder or visit our online documentation.

🤝 Contributing

Interested in contributing to Dermscan? We welcome contributions of all forms. Please read our CONTRIBUTING.md for more information on how to get involved.

📜 License

Dermscan is released under the MIT License. See the LICENSE file for more details.

💡 Questions or Feedback?

Have questions or feedback? Open an issue in this repository, or reach out to us directly through our support channel.

---

Thank you for choosing Dermscan as your go-to skincare analysis tool! 🌿🌸