Skip to main content

Automate digital tool categorization and uncover potential use-cases with AIrToolClassifier.

Project description

AIrToolClassifier Documentation

Overview

Have you ever stumbled upon an online tool and thought, "This could come in handy someday," only to bookmark it or jot it down on a list, but never really keep track of it? Enter AIrToolClassifier.

Designed to revolutionize how we handle digital tools, this tool automates the categorization process into predefined categories and uncovers potential use-cases. Utilizing artificial intelligence through OpenAI's GPT-3.5 Turbo model, this Python-based application creates a bridge to Airtable, facilitating the classification and identification of use-cases, which are then stored in an Airtable database. This enables your personal AI agent to access this database, ensuring you have the right tools at your fingertips to tackle future challenges more effectively. AIrToolClassifier not only helps you maintain a comprehensive database of online tools but also ensures your personal AI agent can leverage this knowledge to support your future projects efficiently.

Features

  • Automated Categorization: Simplifies the organization of digital tools into predefined categories.
  • Use-Case Identification: Uncovers potential applications for each tool, enhancing productivity.
  • AI-Powered: Utilizes artificial intelligence through OpenAI's GPT-3.5 Turbo model.
  • Integration with Airtable: Facilitates classification and use-case identification, storing this valuable information in an Airtable database.

Installations

  1. Ensure Python 3.8+ is installed on your system.
  2. Clone the repository to your local machine.
  3. Install required dependencies by running pip install -r requirements.txt.

Configuration

The tool requires configuration of API keys and other parameters through environment variables or 1Password. The necessary variables include:

  • OPENAI_API_KEY: API key for OpenAI.
  • AIRTABLE_API_KEY: API key for Airtable.
  • AIRTABLE_BASE_ID: Base ID for the target Airtable base.
  • AIRTABLE_TABLE_NAME: Name of the table within the Airtable base.
  • PROMPTS_DIR_PATH: Directory path where prompt templates are stored.

For these configurations, a .env_template file is provided. To use it, remove the "_template" from the file name.

Usage

To start the AirToolClassifier, navigate to the project directory and execute the CLI script:

python -m airtoolclassifier

Follow the interactive prompts to input the tool's name and link. The system will classify the tool and allow for manual adaptations before saving the classification to Airtable.

Development

This project is structured into several modules:

  • airtable_service.py: Manages interactions with Airtable.
  • classifier.py: Handles the creation of prompts and the classification logic.
  • cli.py: Provides a command-line interface for user interaction.
  • config.py: Loads and manages configuration settings.
  • openai_service.py: Manages communication with OpenAI's API.

Contributing

Contributions to the AirToolClassifier are welcome. Please follow the standard fork and pull request workflow.

License

For support and queries, please open an issue on the project's GitHub repository.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

AIrToolClassifier-1.0.0.tar.gz (9.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

AIrToolClassifier-1.0.0-py3-none-any.whl (11.0 kB view details)

Uploaded Python 3

File details

Details for the file AIrToolClassifier-1.0.0.tar.gz.

File metadata

  • Download URL: AIrToolClassifier-1.0.0.tar.gz
  • Upload date:
  • Size: 9.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for AIrToolClassifier-1.0.0.tar.gz
Algorithm Hash digest
SHA256 e5735b6ba2d1114e47847b91f2919e30b812ee15bc0a1f4f70a66f654aac27e1
MD5 2877f9143af42cd375c787c90dab1607
BLAKE2b-256 82a38c4e58e6c5d084991badd862c649d7c81b3c7e58c5ef7bd7d9c8b0942434

See more details on using hashes here.

File details

Details for the file AIrToolClassifier-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for AIrToolClassifier-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 45d06f53a1547e64df396c126b6a5eff64c06137f5d914e202dd6b483a712391
MD5 7965469eeacb1809378bf91d3aac7c21
BLAKE2b-256 da5ff5d0ebc93fb83a8e6780ddbf8f3342bdca9f374cd4a4c25d7744ea16bfc4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page