Skip to content

0aaryan/article.ai

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Article.ai

Article.ai is a versatile project that empowers you to generate blog content, whether you have a specific topic in mind or a collection of URLs to explore. Leveraging OpenAI's language models, the project provides functionality to convert topics into articles, articles into articles (with summarization), and extract URLs from a given source.

Features

  • Generate Blog Content:

    • From URLs: Input a list of URLs, and the system will generate detailed blog content.
    • From Topics: Specify a topic, and the system will craft an article around it.
  • Summarization:

    • The ability to summarize existing articles, extracting key information and generating concise summaries.
  • URL Extraction:

    • Utilize the newspaper library to extract URLs from a given source, aiding in content discovery.

Getting Started

Prerequisites

Make sure you have Python installed on your system. You can download it from python.org.

Installation

  1. Clone the repository:

    git clone https://github.com/0aaryan/article.ai.git
  2. Navigate to the project directory:

    cd article.ai
  3. Install dependencies:

    pip install -r requirements.txt
  4. Create a .env file in the project root with your OpenAI API key:

    OPENAI_API_KEY=your_api_key_here

Usage

  1. Run the Streamlit app:

    streamlit run app.py
  2. Extract URLs:

    • Enter the source URL in the "Source URL" text area.
    • Click on "Extract URLs" to discover and display a list of article URLs.
  3. Generate Blogs:

    • Enter URLs or topics in the respective text areas, separated by newlines.
    • Click on "Generate Blogs" to produce detailed blog content.
  4. Resize Images:

    • Click on "Resize Images" to standardize image dimensions.
  5. Convert to Markdown:

    • Click on "Convert to Markdown" to convert blogs to Markdown format.
    • Generated Markdown files will be displayed, and you can click on them to view or download.
  6. Clear Temporary Files:

    • Optional: Click on "Clear Temporary Files" to remove temporary files.

Folder Structure

  • articleai/: Python package containing blog and image generators.
  • generators/: Python modules for blog and image generation.
  • static/output_template/: Output template for blog content.
  • output/: Generated blogs and images.
  • app.py: Streamlit app for interaction.
  • requirements.txt: Project dependencies.
  • readme.md: Project documentation.

Contribution Guidelines

  1. Fork the repository.

  2. Clone your forked repository:

    git clone https://github.com/0aaryan/article.ai.git
  3. Create a new branch for your feature or bug fix:

    git checkout -b feature/your-feature-name
  4. Make your changes and commit:

    git commit -m "Add your commit message here"
  5. Push your changes to your fork:

    git push origin feature/your-feature-name
  6. Create a pull request on the main repository.

Contributors

License

This project is licensed under the MIT License - see the LICENSE file for details.


Please replace `"your_api_key_here"` in the `.env` example with your actual OpenAI API key. Feel free to customize the contribution guidelines section further based on your specific expectations for contributors.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors