Spaces:
Running
Running
| title: License Cat Analyzer | |
| emoji: 😻 | |
| colorFrom: yellow | |
| colorTo: gray | |
| sdk: gradio | |
| sdk_version: 5.33.2 | |
| app_file: app.py | |
| pinned: false | |
| license: apache-2.0 | |
| short_description: Simple software license analyzer | |
| thumbnail: >- | |
| /static-proxy?url=https%3A%2F%2Fcdn-uploads.huggingface.co%2Fproduction%2Fuploads%2F646285b88bd7025ebe839c0c%2FXT-DyaN7KtU9-_xEQM45l.png%3C%2Fspan%3E%3C!-- HTML_TAG_END --> | |
| # License 🐱 Analyzer | |
| Understand any software license in seconds, not hours. | |
| Have you ever gotten lost in the legal jargon of a software license? Have you ever wondered if you could use a package in your commercial project? Say goodbye to fear and uncertainty. | |
| **License 🐱 Analyzer** is your personal AI legal support, an open-source tool that leverages the power of advanced language models (like Llama 3, Gemma 2, and more) to transform dense legal texts into clear, concise, and standardized summaries. | |
| --- | |
| ## 🚀 Live Demo | |
| 👉 **[TRY IT NOW ON HUGGING FACE SPACES](https://huggingface.co/spaces/jsmanrique/license-cat-analyzer)** 👈 | |
| --- | |
| ## ✨ Key Features | |
| * **Instant Summaries:** Paste any license text and get an instant analysis. | |
| * **Standardized Format:** Forget about interpretations. Get information consistently in the same clear, direct format: | |
| * ✅ **Permissions:** What you can do. | |
| * ❌ **Limitations:** What you cannot do. | |
| * ℹ️ **Conditions:** What you must do. | |
| * **AI Model Selection:** Choose from several of the best open language models to perform the analysis. Compare results and use the one that best suits your needs! | |
| * **Open Source & Community-Driven:** Created by and for the developer community. Your feedback and contributions are the engine of this project. | |
| --- | |
| ## 🤝 Join the Mission! Want to Contribute? | |
| We believe that understanding free software should be easy and accessible for everyone. If you share this vision, you're welcome! There are many ways to help, from reporting a bug to implementing exciting new features. | |
| --- | |
| ## 🗺️ Roadmap & Ideas for Contributing | |
| Here are some ideas to take this project to the next level! If you're interested in any, open an issue to discuss it. | |
| * 💡 **Analysis from URL:** Allow pasting a GitHub repository URL (e.g., .../blob/main/LICENSE) to automatically analyze the license. | |
| * ✨ **Add More Models:** Integrate new LLMs as they emerge. | |
| * 🌐 **Internationalization (i18n):** Translate the interface into more languages. | |
| * 📋 **"Copy Markdown" Button:** To easily copy the generated summary. | |
| * ⭐ **Rating System:** Allow users to rate the quality of the summary generated by each model (this would be amazing!). | |
| * 🎨 **UI/UX Improvements:** Do you have ideas to make the interface more intuitive or attractive? Go for it! | |
| * ⚡ **Optimization & Caching:** Implement a caching system to avoid regenerating summaries for common licenses. | |
| --- | |
| ## 🛠️ Local Setup Guide | |
| Ready to get started? Follow these steps to run the project on your machine: | |
| 1. **Clone the repository:** | |
| ```bash | |
| git clone https://huggingface.co/spaces/jsmanrique/license-cat-analyzer | |
| cd license-cat-analyzer | |
| ``` | |
| 2. **Create and activate a virtual environment:** | |
| ```bash | |
| python -m venv venv | |
| source venv/bin/activate # On Windows: venv\Scripts\activate | |
| ``` | |
| 3. **Install dependencies:** | |
| ```bash | |
| pip install -r requirements.txt | |
| ``` | |
| 4. **Configure your Hugging Face Token:** | |
| To use the Inference API, you need a token. The most secure way is via environment variables. | |
| ```bash | |
| export HUGGINGFACE_HUB_TOKEN='hf_your_token_here' | |
| ``` | |
| 5. **Run the application:** | |
| ```bash | |
| python app.py | |
| ``` | |
| And that's it! The application should be running at `http://127.0.0.1:7860`. | |
| --- | |
| ## 🙌 How to Contribute | |
| We follow the standard GitHub flow: | |
| 1. Fork this repository. | |
| 2. Create a new branch for your feature (`git checkout -b feature/your-feature-name`). | |
| 3. Make your changes and commit them. | |
| 4. Push to your branch (`git push origin feature/your-feature-name`). | |
| 5. Open a Pull Request detailing the changes you've made. | |
| Every contribution, no matter how small, is greatly appreciated! | |
| --- | |
| ## 💻 Tech Stack | |
| * **Backend:** Python | |
| * **UI Framework:** Gradio | |
| * **Platform:** Hugging Face Spaces | |
| * **AI Models:** Via Hugging Face Inference API | |
| --- | |
| ## 📜 License | |
| This project is licensed under the Apache 2.0 License. Feel free to use, modify, and distribute it. |