# NCeu (NCurses Email Usage)
NCeu is a command-line interface tool for managing and analyzing your Gmail inbox, inspired by the ncdu (NCurses Disk Usage) utility. It provides an interactive, text-based user interface for exploring your emails, grouping them by sender, and performing actions like archiving.
## Features
- Authenticate with Gmail using OAuth2
- Download and analyze emails from your inbox
- Group emails by sender
- Sort emails by count or date
- View email details
- Archive individual emails or all emails from a sender directly from the interface
- Progress bar for archiving multiple emails
- ncurses-based UI for smooth navigation
## Prerequisites
- Python 3.6+
- pip (Python package manager)
## Installation
You can install NCeu using pip:
```
pip install nceu
```
This will install NCeu as a system-wide application.
If you want to install it from source:
1. Clone this repository:
```
git clone https://github.com/ad3002/nceu.git
cd nceu
```
2. Install the package:
```
pip install .
```
3. Set up Google Cloud Project and enable Gmail API:
- Go to the [Google Cloud Console](https://console.cloud.google.com/)
- Create a new project
- Enable the Gmail API for your project
- Create credentials (OAuth client ID) for a desktop application
- Download the client configuration and save it as `credentials.json` in your working directory
## Setting Up a Test User
For security reasons, it's recommended to set up a test Gmail account instead of using your primary account during development and testing:
1. Create a new Gmail account for testing purposes.
2. In your Google Cloud Console project:
- Go to the OAuth consent screen settings
- Add your test Gmail address to the "Test users" section
3. Use this test account when authorizing the application during development and testing.
This approach allows you to safely test all features without risking your primary email account.
## Usage
After installation, you can run NCeu from anywhere in your system by simply typing:
```
nceu
```
On first run, you'll be prompted to authorize the application. Follow the provided URL to grant necessary permissions. Use your test account credentials for this step.
### Navigation
- Use arrow keys to move up and down the list
- Press 'Enter' to view emails from a sender or email details
- Press 's' to change sort order (in sender view)
- Press 'a' to archive an email (in email view)
- Press 'a' to archive all emails from a sender (in sender view) with a progress bar showing the status
- Press 'q' to go back or quit the application
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Acknowledgments
- Inspired by the ncdu utility
- Uses Google's Gmail API
## Disclaimer
This tool requires access to your Gmail account. Please review the code and use it at your own risk. Always be cautious when granting access to your email account, and preferably use a test account as described in the "Setting Up a Test User" section.
Raw data
{
"_id": null,
"home_page": "https://github.com/ad3002/nceu",
"name": "nceu",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Aleksey Komissarov",
"author_email": "ad3002@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/52/e1/45a10ae3125ef744a9cc927bd6a8982971b2ab0d9d452e051ecb3f4b3817/nceu-0.3.0.tar.gz",
"platform": null,
"description": "# NCeu (NCurses Email Usage)\n\nNCeu is a command-line interface tool for managing and analyzing your Gmail inbox, inspired by the ncdu (NCurses Disk Usage) utility. It provides an interactive, text-based user interface for exploring your emails, grouping them by sender, and performing actions like archiving.\n\n## Features\n\n- Authenticate with Gmail using OAuth2\n- Download and analyze emails from your inbox\n- Group emails by sender\n- Sort emails by count or date\n- View email details\n- Archive individual emails or all emails from a sender directly from the interface\n- Progress bar for archiving multiple emails\n- ncurses-based UI for smooth navigation\n\n## Prerequisites\n\n- Python 3.6+\n- pip (Python package manager)\n\n## Installation\n\nYou can install NCeu using pip:\n\n```\npip install nceu\n```\n\nThis will install NCeu as a system-wide application.\n\nIf you want to install it from source:\n\n1. Clone this repository:\n ```\n git clone https://github.com/ad3002/nceu.git\n cd nceu\n ```\n\n2. Install the package:\n ```\n pip install .\n ```\n\n3. Set up Google Cloud Project and enable Gmail API:\n - Go to the [Google Cloud Console](https://console.cloud.google.com/)\n - Create a new project\n - Enable the Gmail API for your project\n - Create credentials (OAuth client ID) for a desktop application\n - Download the client configuration and save it as `credentials.json` in your working directory\n\n## Setting Up a Test User\n\nFor security reasons, it's recommended to set up a test Gmail account instead of using your primary account during development and testing:\n\n1. Create a new Gmail account for testing purposes.\n2. In your Google Cloud Console project:\n - Go to the OAuth consent screen settings\n - Add your test Gmail address to the \"Test users\" section\n3. Use this test account when authorizing the application during development and testing.\n\nThis approach allows you to safely test all features without risking your primary email account.\n\n## Usage\n\nAfter installation, you can run NCeu from anywhere in your system by simply typing:\n\n```\nnceu\n```\n\nOn first run, you'll be prompted to authorize the application. Follow the provided URL to grant necessary permissions. Use your test account credentials for this step.\n\n### Navigation\n\n- Use arrow keys to move up and down the list\n- Press 'Enter' to view emails from a sender or email details\n- Press 's' to change sort order (in sender view)\n- Press 'a' to archive an email (in email view)\n- Press 'a' to archive all emails from a sender (in sender view) with a progress bar showing the status\n- Press 'q' to go back or quit the application\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Acknowledgments\n\n- Inspired by the ncdu utility\n- Uses Google's Gmail API\n\n## Disclaimer\n\nThis tool requires access to your Gmail account. Please review the code and use it at your own risk. Always be cautious when granting access to your email account, and preferably use a test account as described in the \"Setting Up a Test User\" section.\n",
"bugtrack_url": null,
"license": null,
"summary": "A ncurses-based Gmail inbox analyzer and manager",
"version": "0.3.0",
"project_urls": {
"Homepage": "https://github.com/ad3002/nceu"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "52e145a10ae3125ef744a9cc927bd6a8982971b2ab0d9d452e051ecb3f4b3817",
"md5": "23a57b4b81ba75defabb6686b23dbef6",
"sha256": "0d83a1cfab7623be27d747718315b90c93317da496b4b881cbd00bc62ae04503"
},
"downloads": -1,
"filename": "nceu-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "23a57b4b81ba75defabb6686b23dbef6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 7782,
"upload_time": "2024-08-22T11:30:00",
"upload_time_iso_8601": "2024-08-22T11:30:00.949021Z",
"url": "https://files.pythonhosted.org/packages/52/e1/45a10ae3125ef744a9cc927bd6a8982971b2ab0d9d452e051ecb3f4b3817/nceu-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-22 11:30:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ad3002",
"github_project": "nceu",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "nceu"
}
JSON
