# Eshare
`eshare` is a Python command-line tool for securely sharing files. It command-line tool for securely encrypting files, sharing them with time-limited tokens, and decrypting them using a password.
## Features
- Encrypt files with a password.
- Generate time-limited shareable tokens.
- Decrypt files securely with the token and password.
## Installation
To install `eshare`, use pip:
```bash
pip install eshare
```
## Usage
Here’s a brief guide on how to use the `eshare` command-line tool.
### Encrypting a File
To encrypt a file, use the `eshare encrypt` command with the `--file` flag to specify the file and the `--password` flag for encryption.
```bash
eshare encrypt --file example.txt --password mypassword
```
This will encrypt `example.txt` using the provided password.
### Share a File
```bash
eshare share --file example.txt.enc --expire 24 --password mypassword
```
This will generate file shareable token, token is used to decrypt the file.
### Decrypting a File
To decrypt an encrypted file, use the `eshare decrypt` command along with the `--file`, `--token` and `--password` flags:
```bash
eshare decrypt --file example.txt.enc --token <token> --password mypassword
```
This will decrypt the encrypted file `example.txt.enc` using the provided token and password.
### Viewing Help
To view the help options and available commands for `eshare`, run:
```bash
eshare help
```
To view the help options for specific command, run:
```bash
eshare share --help
```
## Example
Here’s a complete example of encrypting and decrypting a file:
```bash
# Encrypt a file
eshare encrypt --file example.txt --password mypassword
# Share a file
eshare share --file example.txt.enc --expire 24 --password mypassword
# Decrypt the file
eshare decrypt --file example.txt.enc --token <token> --password mypassword
```
## About the Author
`eshare` is created by Parth Dudhatra (imParth), a passionate software engineer, developer advocate, and content creator known for his contributions to the tech community. He is passionate about Python programming, open-source software, and sharing knowledge with others.
Parth is active on various social media platforms, where he shares insights, tutorials, and tips related to programming, software development, and security. Connect with Parth Dudhatra on social media:
- [Portfolio](https://imparth.me)
- [X/Twitter](https://x.com/imparth73)
- [Instagram](https://instagram.com/imparth.dev)
- [GitHub](https://github.com/imparth7)
- [LinkedIn](https://linkedin.com/in/imparth7)
- [Medium](https://imparth7.medium.com)
- [Dev.to](https://dev.to/imparth)
If you have any questions, feedback, or suggestions, feel free to reach out to me on any platform!
## License
This project is licensed under the ISC License.
## Contributing
Contributions are welcome! Please open an issue or submit a pull request on the [GitHub repository](https://github.com/imparth7/eshare).
## Issues
If you encounter any issues, please report them on the [issues page](https://github.com/imparth7/eshare/issues).
Raw data
{
"_id": null,
"home_page": "https://github.com/imparth7/eshare",
"name": "eshare",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "encryption, file-sharing, cli, secure, python, password, cryptography",
"author": "Parth Dudhatra",
"author_email": "imparth.dev@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/98/b0/6ce2832e017cc92dcff60adfbd062b6f222a94fcac77c7db10243668e510/eshare-1.0.0.tar.gz",
"platform": "Any",
"description": "# Eshare\r\n\r\n`eshare` is a Python command-line tool for securely sharing files. It command-line tool for securely encrypting files, sharing them with time-limited tokens, and decrypting them using a password.\r\n\r\n## Features\r\n\r\n- Encrypt files with a password.\r\n- Generate time-limited shareable tokens.\r\n- Decrypt files securely with the token and password.\r\n\r\n## Installation\r\n\r\nTo install `eshare`, use pip:\r\n\r\n```bash\r\npip install eshare\r\n```\r\n\r\n## Usage\r\n\r\nHere\u00e2\u20ac\u2122s a brief guide on how to use the `eshare` command-line tool.\r\n\r\n### Encrypting a File\r\n\r\nTo encrypt a file, use the `eshare encrypt` command with the `--file` flag to specify the file and the `--password` flag for encryption.\r\n\r\n```bash\r\neshare encrypt --file example.txt --password mypassword\r\n```\r\n\r\nThis will encrypt `example.txt` using the provided password.\r\n\r\n### Share a File\r\n\r\n```bash\r\neshare share --file example.txt.enc --expire 24 --password mypassword\r\n```\r\n\r\nThis will generate file shareable token, token is used to decrypt the file.\r\n\r\n### Decrypting a File\r\n\r\nTo decrypt an encrypted file, use the `eshare decrypt` command along with the `--file`, `--token` and `--password` flags:\r\n\r\n```bash\r\neshare decrypt --file example.txt.enc --token <token> --password mypassword\r\n```\r\n\r\nThis will decrypt the encrypted file `example.txt.enc` using the provided token and password.\r\n\r\n### Viewing Help\r\n\r\nTo view the help options and available commands for `eshare`, run:\r\n\r\n```bash\r\neshare help\r\n```\r\n\r\nTo view the help options for specific command, run:\r\n\r\n```bash\r\neshare share --help\r\n```\r\n\r\n## Example\r\n\r\nHere\u00e2\u20ac\u2122s a complete example of encrypting and decrypting a file:\r\n\r\n```bash\r\n# Encrypt a file\r\neshare encrypt --file example.txt --password mypassword\r\n\r\n# Share a file\r\neshare share --file example.txt.enc --expire 24 --password mypassword\r\n\r\n# Decrypt the file\r\neshare decrypt --file example.txt.enc --token <token> --password mypassword\r\n```\r\n\r\n## About the Author\r\n\r\n`eshare` is created by Parth Dudhatra (imParth), a passionate software engineer, developer advocate, and content creator known for his contributions to the tech community. He is passionate about Python programming, open-source software, and sharing knowledge with others.\r\n\r\nParth is active on various social media platforms, where he shares insights, tutorials, and tips related to programming, software development, and security. Connect with Parth Dudhatra on social media:\r\n\r\n- [Portfolio](https://imparth.me)\r\n- [X/Twitter](https://x.com/imparth73)\r\n- [Instagram](https://instagram.com/imparth.dev)\r\n- [GitHub](https://github.com/imparth7)\r\n- [LinkedIn](https://linkedin.com/in/imparth7)\r\n- [Medium](https://imparth7.medium.com)\r\n- [Dev.to](https://dev.to/imparth)\r\n\r\nIf you have any questions, feedback, or suggestions, feel free to reach out to me on any platform!\r\n\r\n## License\r\n\r\nThis project is licensed under the ISC License.\r\n\r\n## Contributing\r\n\r\nContributions are welcome! Please open an issue or submit a pull request on the [GitHub repository](https://github.com/imparth7/eshare).\r\n\r\n## Issues\r\n\r\nIf you encounter any issues, please report them on the [issues page](https://github.com/imparth7/eshare/issues).\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Encrypted File Sharing Command-Line Tool",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/imparth7/eshare"
},
"split_keywords": [
"encryption",
" file-sharing",
" cli",
" secure",
" python",
" password",
" cryptography"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8d4c21307386a3920f3eaf53cdd62cf1c3140128cbfa1287553c7c5dd698b6bb",
"md5": "ca2aed5205841a65c7c8d6d4d4abc6ed",
"sha256": "4ada6c8ea3c91cee6b81ef6c74cc6e6629e12eb9d7f755b42404ad61d247e095"
},
"downloads": -1,
"filename": "eshare-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ca2aed5205841a65c7c8d6d4d4abc6ed",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 6641,
"upload_time": "2024-12-10T10:41:32",
"upload_time_iso_8601": "2024-12-10T10:41:32.164831Z",
"url": "https://files.pythonhosted.org/packages/8d/4c/21307386a3920f3eaf53cdd62cf1c3140128cbfa1287553c7c5dd698b6bb/eshare-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "98b06ce2832e017cc92dcff60adfbd062b6f222a94fcac77c7db10243668e510",
"md5": "a6a4d53e5c472d819bc39f4c463d6442",
"sha256": "b2ae96e0b8239d9b02a4dc758b85c8c299ba4917d1e51b8d93b5fbf563a2cc80"
},
"downloads": -1,
"filename": "eshare-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "a6a4d53e5c472d819bc39f4c463d6442",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 5404,
"upload_time": "2024-12-10T10:41:36",
"upload_time_iso_8601": "2024-12-10T10:41:36.774391Z",
"url": "https://files.pythonhosted.org/packages/98/b0/6ce2832e017cc92dcff60adfbd062b6f222a94fcac77c7db10243668e510/eshare-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-10 10:41:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "imparth7",
"github_project": "eshare",
"github_not_found": true,
"lcname": "eshare"
}
JSON
