Skip to content

CantCode023/NURS

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

85 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

main menu

NURS

NURS (NILAM Unsupervised Reasoning Summarizer) is an automated software tool designed to scrape, summarize, and process articles from Medium.com and uploads them to your AINS (Advanced Integration NILAM System) account (NURS AINS lol).

Table of Contents

  1. Installation
  2. Configuration
  3. Usage
  4. Contributing
  5. License
  6. Support

📦 Installation

  1. Clone the repository:
git clone https://github.com/CantCode023/NURS.git
  1. Install required dependencies:
pip install -r NURS/requirements.txt

🔧 Configuration

NURS requires two API keys to function:

  • Gemini API Key (for content summarization)
  • JB App Token (for authentication)

These can be configured in two ways:

  1. Create a .env file in the project directory:
GEMINI_API_KEY=your_gemini_api_key
jb_app_token=your_jb_app_token
  1. Input through CLI when prompted (if .env file is not found)

🚀 Usage

  1. Go into NURS directory
cd NURS
  1. Run the CLI
python __main__.py

Main Menu Options

  1. Upload NILAM
  2. Update API Keys
  3. Exit

Uploading an Article

  1. Select option 1 from the main menu
  2. Enter the Medium article URL
  3. Wait for the processing and summarization
  4. Review the generated summary
  5. Automatic upload to AINS

Updating API Keys

  1. Select option 2 from the main menu
  2. Choose which key to update:
    • Gemini API Key
    • JB App Token
  3. Enter the new key value

Here's a video demonstrating the process:

Watch the video

🙍‍♂️ Contributing

Please read the CODE_OF_CONDUCT.md for details on the code of conduct and the process for submitting pull requests.

📝 License

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

📞 Support

For support or questions, contact:

🖊️ TODO-List

  • Add function to scrape website text in text_processing.py
  • Make summarizer function using Google Gemini
  • Add functions to get provider key and bearer authorization
  • Use request to upload nilam
    • Make custom stars (int 1-5) and favourite (bool)
  • Add bad words filter in utils, make a custom exception in exceptions.py
    • Add other exceptions like bad api key, etc
  • Make cli
    • add cooldown between requests
  • ⚡ Optimize get_provider and get_bearer_authorization
  • Add News API support

Made with ❤️ by @CantCode023

About

NILAM Unsupervised Reasoning Summarizer, an AINS automation tool.

Resources

License

Code of conduct

Stars

Watchers

Forks

Languages