| Name | chinaski JSON |
| Version |
1.0.2
JSON |
| download |
| home_page | |
| Summary | Detect email addresses in files |
| upload_time | 2023-10-06 15:40:40 |
| maintainer | |
| docs_url | None |
| author | w0rmr1d3r |
| requires_python | >=3.9.0 |
| license | GPLv3 |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# chinaski
Detect email addresses in files.
A tribute to the novel [Post Office](https://en.wikipedia.org/wiki/Post_Office_(novel)) from Charles Bukowski.
[](https://pypi.org/project/chinaski/)
[](https://github.com/w0rmr1d3r/chinaski/releases)
[](https://pypistats.org/packages/chinaski)
## Installation
Use the package manager [pip](https://pip.pypa.io/en/stable/) to install chinaski.
```bash
pip install chinaski
```
## Usage
### As CLI
```text
Usage: python -m chinaski [OPTIONS] PATH_TO_FILE_OR_DIR
Detect emails addresses in files.
PATH_TO_FILE_OR_DIR: Path to single file or directory to scan.
Options:
--help Show this message and exit.
```
Example:
```bash
# Detect in only 1 file
python -m chinaski ./file.txt
# Detect in a directory
python -m chinaski path/to/dir
```
### Inside your code
```python
from chinaski.henry import core
if __name__ == '__main__':
core("file.txt")
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first
to discuss what you would like to change.
Please make sure to update tests as appropriate.
## License
[GPLv3](LICENSE)
Raw data
{
"_id": null,
"home_page": "",
"name": "chinaski",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9.0",
"maintainer_email": "",
"keywords": "",
"author": "w0rmr1d3r",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/b3/1b/e509f714c772a1944e057741eafb7572c9f283df384200942d2a1106cc7f/chinaski-1.0.2.tar.gz",
"platform": null,
"description": "# chinaski\n\nDetect email addresses in files.\nA tribute to the novel [Post Office](https://en.wikipedia.org/wiki/Post_Office_(novel)) from Charles Bukowski.\n\n[](https://pypi.org/project/chinaski/)\n[](https://github.com/w0rmr1d3r/chinaski/releases)\n\n[](https://pypistats.org/packages/chinaski)\n\n## Installation\n\nUse the package manager [pip](https://pip.pypa.io/en/stable/) to install chinaski.\n\n```bash\npip install chinaski\n```\n\n## Usage\n\n### As CLI\n\n```text\nUsage: python -m chinaski [OPTIONS] PATH_TO_FILE_OR_DIR\n\n Detect emails addresses in files.\n\n PATH_TO_FILE_OR_DIR: Path to single file or directory to scan.\n\nOptions:\n --help Show this message and exit.\n```\n\nExample:\n\n```bash\n# Detect in only 1 file\npython -m chinaski ./file.txt\n\n# Detect in a directory\npython -m chinaski path/to/dir\n```\n\n### Inside your code\n\n```python\nfrom chinaski.henry import core\n\nif __name__ == '__main__':\n core(\"file.txt\")\n```\n\n## Contributing\n\nPull requests are welcome. For major changes, please open an issue first\nto discuss what you would like to change.\n\nPlease make sure to update tests as appropriate.\n\n## License\n\n[GPLv3](LICENSE)\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "Detect email addresses in files",
"version": "1.0.2",
"project_urls": {
"Bug Tracker": "https://github.com/w0rmr1d3r/chinaski/issues",
"Changelog": "https://github.com/w0rmr1d3r/chinaski/releases",
"Documentation": "https://github.com/w0rmr1d3r/chinaski",
"Homepage": "https://github.com/w0rmr1d3r/chinaski",
"Repository": "https://github.com/w0rmr1d3r/chinaski"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6b72ca8812083ee63cd2d6803a0d8ce33089f3991e169789422c6e4701c0128b",
"md5": "8801243e204bd6200d98dec401364796",
"sha256": "68b32fe5aaef58035f7b96136b38754ed90c45e7568976fa9c2213c01035bb77"
},
"downloads": -1,
"filename": "chinaski-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8801243e204bd6200d98dec401364796",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9.0",
"size": 17954,
"upload_time": "2023-10-06T15:40:38",
"upload_time_iso_8601": "2023-10-06T15:40:38.854607Z",
"url": "https://files.pythonhosted.org/packages/6b/72/ca8812083ee63cd2d6803a0d8ce33089f3991e169789422c6e4701c0128b/chinaski-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b31be509f714c772a1944e057741eafb7572c9f283df384200942d2a1106cc7f",
"md5": "aa6d50c83e6d5bdc41d99fb78870b8b5",
"sha256": "4e7cdab4d5a6c72cded6f8cc9ed13bbbdac4ef71f65b132d595ae33bf50006f7"
},
"downloads": -1,
"filename": "chinaski-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "aa6d50c83e6d5bdc41d99fb78870b8b5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9.0",
"size": 17198,
"upload_time": "2023-10-06T15:40:40",
"upload_time_iso_8601": "2023-10-06T15:40:40.365262Z",
"url": "https://files.pythonhosted.org/packages/b3/1b/e509f714c772a1944e057741eafb7572c9f283df384200942d2a1106cc7f/chinaski-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-06 15:40:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "w0rmr1d3r",
"github_project": "chinaski",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "chinaski"
}
