<div align="center">
# NEPSE Utils
CLI Application written in Python to automatically apply IPO openings from multiple accounts at once!
</div>
## Commands:
| Command | Description |
| --------------- | ------------------------------------------------------------------ |
| `add` | Add an account |
| `apply` | Apply open issues |
| `result` | Check IPO result |
| `status` | Check IPO application status |
| `tag` | Tag an account to group them |
| `select` | Selects accounts with specific tag to be used for further commands |
| `portfolio` | List portfolio of an account |
| `sync` | Syncs unfetched portfolio and application status from MeroShare |
| `stats` | Shows overall statistics of accounts |
| `remove` | Remove an account |
| `change lock` | Change unlock password |
| `list accounts` | Show list of accounts |
| `list results` | Show list of results |
| `loglevel` | Set log level |
| `telegram` | Enable or disable telegram notification |
| `help` | Shows list of commands |
| `exit` | Exit the shell |
**Note: Use `help {command}` for help regarding commands!**
## Installation instruction
- Install Python (Version greater than 3.9) using your package manager.
- Install nepseutils using pipx (recommended): `pipx install nepseutils`
- Launch from command line with `nepseutils`
_Note: If pipx is not available, use pip to install using `pip3 install nepseutils` and launch using `python -m nepseutils`_
## Basic Usage
You can launch nepseutils by entering `nepseutils` in your command line. On the first launch, it will ask you to set a new password for nepseutils (Not MeroShare). You will have to enter this next time you launch nepseutils.
### Launching nepseutils
```
nepseutils
```
OR
```
python -m nepseutils
```
### Adding an account
#### Command:
```
add {16_digit_dmat_number} {meroshare_password} {crn} {meroshare_pin}
```
_You don't need to enter other infos. It will be automatically obtained._
#### Example:
```
NepseUtils > add 1234567891234567 myp@ssw0rd 02-R00222224 1234
```
#### Sample Output:
```
Successfully obtained details for account: Ram Bahadur
```
### Applying for IPO
#### Command:
```
apply
```
Then you will see this kind of output:
```
NepseUtils > apply
+----------+----------------+-------+------------+
| Share ID | Company Name | Scrip | Close Date |
+----------+----------------+-------+------------+
| 401 | Sample Company | SMPL | 2021-01-01 |
+----------+--------------+-------+--------------+
Enter Share ID:
```
Enter share ID of company that you want to apply for.
```
Enter Share ID: 401
Units to Apply:
```
Enter number of units (Not rupees) that you want to apply. This will apply IPO for all the added accounts.
### Checking IPO Result
#### Command:
```
result
```
#### Sample Output:
```
NepseUtils > result
+----+------------+-------------------------------------------------+
| ID | Scrip | Name |
+----+------------+-------------------------------------------------+
| 1 | MLBSL | MAHILA LAGHUBITTA BITTIYA SANSTHA LTD. |
| 2 | SBCF | Sunrise Bluechip Fund |
| 3 | JLIC | Jyoti Life Insurance Ltd |
| 4 | NIBLSFUND | NIBL Samriddhi Fund -2 |
| 5 | CHDC | CEDB Hydropower Development Company Ltd |
| 6 | PSFUND | Prabhu Select Fund |
| 7 | NMBD209293 | 4% NMB Energy Bond 2092/93 |
| 8 | PRVUD2087 | 8.5 % PRVU Debenture 2087 |
| 10 | MKJCL | Mailung Khola Jal Vidhyut Company Ltd. |
| 11 | SLIL | Sanima Life Insurance Limited |
| 12 | NABILD2085 | 8% Nabil Debenture 2085 |
| 13 | MALBSL | Manushi Laghubitta Bittiya Sanstha Limited |
| 14 | MEGAMF | Mega Mutual Fund -1 |
| 15 | TPCL | Terhathum Power Company Ltd |
| 16 | NMBSBFE | NMB Saral Bachat Fund - E |
| 17 | NBF3 | Nabil Balanced Fund 3 |
| 18 | SUL | Sahas Urja Ltd. |
| 19 | BBNHCL | Buddhabhumi Nepal Hydro Power Co. Ltd. |
| 20 | NYADI | Nyadi Hydropower Limited |
| 21 | MBKJCL | Madhya Bhotekoshi Jalabidhyut Company Ltd. |
| 22 | SPCL | Samling Power Company Ltd. |
| 23 | CBLD2088 | Civil Bank Debenture 2088 |
| 24 | JSLBS | Jalpa Samudayik Laghubitta Bittiya Sanstha Ltd. |
| 25 | ENL | Emerging Nepal Limited |
+----+------------+-------------------------------------------------+
Choose a company ID:
```
Enter ID of company that you want to check result for.
```
Choose a company ID: 21
+----------------------------+---------+----------+
| Name | Alloted | Quantity |
+----------------------------+---------+----------+
| Ram Bahadur | False | None |
| Hari Bahadur | True | 10 |
| Shyam Prasad | False | None |
+----------------------------+---------+----------+
```
### Removing account
#### Command:
```
remove
```
#### Sample Output
```
+----+----------------------------+------------------+------------------+--------------+
| ID | Name | DMAT | Account | CRN |
+----+----------------------------+------------------+------------------+--------------+
| 1 | Ram Bahadur | 1201970008888888 | 0075757575757575 | 07-819284939 |
| 2 | Hari Bahadur | 1201970007878887 | 8758752835478 | M52394589 |
| 3 | Shyam Prasad | 1201970002278282 | 5923459259243594 | F59824935 |
+----+----------------------------+------------------+------------------+--------------+
Choose an account ID:
```
Then choose account to remove.
### Show added accounts
#### Command:
```
list accounts
```
#### Sample Output
```
+----+----------------------------+------------------+------------------+--------------+
| ID | Name | DMAT | Account | CRN |
+----+----------------------------+------------------+------------------+--------------+
| 1 | Ram Bahadur | 1201970008888888 | 0075757575757575 | 07-819284939 |
| 2 | Hari Bahadur | 1201970007878887 | 8758752835478 | M52394589 |
| 3 | Shyam Prasad | 1201970002278282 | 5923459259243594 | F59824935 |
+----+----------------------------+------------------+------------------+--------------+
```
Raw data
{
"_id": null,
"home_page": "https://github.com/arpandaze/nepseutils",
"name": "nepseutils",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "nepse, meroshare, tms",
"author": "Daze",
"author_email": "dazehere@yandex.com",
"download_url": "https://files.pythonhosted.org/packages/9b/7c/24be7c9661e1651c84f95ad39df4cc243c4d0cb1330c6604cca1e82ecfaf/nepseutils-0.4.7.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n# NEPSE Utils\n\n\n\n\n\nCLI Application written in Python to automatically apply IPO openings from multiple accounts at once!\n\n</div>\n\n## Commands:\n\n| Command | Description |\n| --------------- | ------------------------------------------------------------------ |\n| `add` | Add an account |\n| `apply` | Apply open issues |\n| `result` | Check IPO result |\n| `status` | Check IPO application status |\n| `tag` | Tag an account to group them |\n| `select` | Selects accounts with specific tag to be used for further commands |\n| `portfolio` | List portfolio of an account |\n| `sync` | Syncs unfetched portfolio and application status from MeroShare |\n| `stats` | Shows overall statistics of accounts |\n| `remove` | Remove an account |\n| `change lock` | Change unlock password |\n| `list accounts` | Show list of accounts |\n| `list results` | Show list of results |\n| `loglevel` | Set log level |\n| `telegram` | Enable or disable telegram notification |\n| `help` | Shows list of commands |\n| `exit` | Exit the shell |\n\n**Note: Use `help {command}` for help regarding commands!**\n\n## Installation instruction\n\n- Install Python (Version greater than 3.9) using your package manager.\n- Install nepseutils using pipx (recommended): `pipx install nepseutils`\n- Launch from command line with `nepseutils`\n\n_Note: If pipx is not available, use pip to install using `pip3 install nepseutils` and launch using `python -m nepseutils`_\n\n## Basic Usage\n\nYou can launch nepseutils by entering `nepseutils` in your command line. On the first launch, it will ask you to set a new password for nepseutils (Not MeroShare). You will have to enter this next time you launch nepseutils.\n\n### Launching nepseutils\n\n```\nnepseutils\n```\nOR\n```\npython -m nepseutils\n```\n\n### Adding an account\n\n#### Command:\n\n```\nadd {16_digit_dmat_number} {meroshare_password} {crn} {meroshare_pin}\n```\n\n_You don't need to enter other infos. It will be automatically obtained._\n\n#### Example:\n\n```\nNepseUtils > add 1234567891234567 myp@ssw0rd 02-R00222224 1234\n```\n\n#### Sample Output:\n\n```\nSuccessfully obtained details for account: Ram Bahadur\n```\n\n### Applying for IPO\n\n#### Command:\n\n```\napply\n```\n\nThen you will see this kind of output:\n\n```\nNepseUtils > apply\n+----------+----------------+-------+------------+\n| Share ID | Company Name | Scrip | Close Date |\n+----------+----------------+-------+------------+\n| 401 | Sample Company | SMPL | 2021-01-01 |\n+----------+--------------+-------+--------------+\nEnter Share ID:\n```\n\nEnter share ID of company that you want to apply for.\n\n```\nEnter Share ID: 401\nUnits to Apply:\n```\n\nEnter number of units (Not rupees) that you want to apply. This will apply IPO for all the added accounts.\n\n### Checking IPO Result\n\n#### Command:\n\n```\nresult\n```\n\n#### Sample Output:\n\n```\nNepseUtils > result\n+----+------------+-------------------------------------------------+\n| ID | Scrip | Name |\n+----+------------+-------------------------------------------------+\n| 1 | MLBSL | MAHILA LAGHUBITTA BITTIYA SANSTHA LTD. |\n| 2 | SBCF | Sunrise Bluechip Fund |\n| 3 | JLIC | Jyoti Life Insurance Ltd |\n| 4 | NIBLSFUND | NIBL Samriddhi Fund -2 |\n| 5 | CHDC | CEDB Hydropower Development Company Ltd |\n| 6 | PSFUND | Prabhu Select Fund |\n| 7 | NMBD209293 | 4% NMB Energy Bond 2092/93 |\n| 8 | PRVUD2087 | 8.5 % PRVU Debenture 2087 |\n| 10 | MKJCL | Mailung Khola Jal Vidhyut Company Ltd. |\n| 11 | SLIL | Sanima Life Insurance Limited |\n| 12 | NABILD2085 | 8% Nabil Debenture 2085 |\n| 13 | MALBSL | Manushi Laghubitta Bittiya Sanstha Limited |\n| 14 | MEGAMF | Mega Mutual Fund -1 |\n| 15 | TPCL | Terhathum Power Company Ltd |\n| 16 | NMBSBFE | NMB Saral Bachat Fund - E |\n| 17 | NBF3 | Nabil Balanced Fund 3 |\n| 18 | SUL | Sahas Urja Ltd. |\n| 19 | BBNHCL | Buddhabhumi Nepal Hydro Power Co. Ltd. |\n| 20 | NYADI | Nyadi Hydropower Limited |\n| 21 | MBKJCL | Madhya Bhotekoshi Jalabidhyut Company Ltd. |\n| 22 | SPCL | Samling Power Company Ltd. |\n| 23 | CBLD2088 | Civil Bank Debenture 2088 |\n| 24 | JSLBS | Jalpa Samudayik Laghubitta Bittiya Sanstha Ltd. |\n| 25 | ENL | Emerging Nepal Limited |\n+----+------------+-------------------------------------------------+\nChoose a company ID:\n```\n\nEnter ID of company that you want to check result for.\n\n```\nChoose a company ID: 21\n+----------------------------+---------+----------+\n| Name | Alloted | Quantity |\n+----------------------------+---------+----------+\n| Ram Bahadur | False | None |\n| Hari Bahadur | True | 10 |\n| Shyam Prasad | False | None |\n+----------------------------+---------+----------+\n```\n\n### Removing account\n\n#### Command:\n\n```\nremove\n```\n\n#### Sample Output\n\n```\n+----+----------------------------+------------------+------------------+--------------+\n| ID | Name | DMAT | Account | CRN |\n+----+----------------------------+------------------+------------------+--------------+\n| 1 | Ram Bahadur | 1201970008888888 | 0075757575757575 | 07-819284939 |\n| 2 | Hari Bahadur | 1201970007878887 | 8758752835478 | M52394589 |\n| 3 | Shyam Prasad | 1201970002278282 | 5923459259243594 | F59824935 |\n+----+----------------------------+------------------+------------------+--------------+\nChoose an account ID:\n```\n\nThen choose account to remove.\n\n### Show added accounts\n\n#### Command:\n\n```\nlist accounts\n```\n\n#### Sample Output\n\n```\n+----+----------------------------+------------------+------------------+--------------+\n| ID | Name | DMAT | Account | CRN |\n+----+----------------------------+------------------+------------------+--------------+\n| 1 | Ram Bahadur | 1201970008888888 | 0075757575757575 | 07-819284939 |\n| 2 | Hari Bahadur | 1201970007878887 | 8758752835478 | M52394589 |\n| 3 | Shyam Prasad | 1201970002278282 | 5923459259243594 | F59824935 |\n+----+----------------------------+------------------+------------------+--------------+\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Collection of scripts to interact with NEPSE related websites!",
"version": "0.4.7",
"project_urls": {
"Homepage": "https://github.com/arpandaze/nepseutils",
"Repository": "https://github.com/arpandaze/nepseutils"
},
"split_keywords": [
"nepse",
" meroshare",
" tms"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d66cffa44102636cc51fcbbced188807a72c8d38e587696dfdb2e88f752a8c82",
"md5": "9ce6d7e34f477fb0cd7e3dd0cd27fa5a",
"sha256": "ec1ba0ed4c62701d73c2ee88fc0bc9f4de95f8d529ad228bdfedea19080fc611"
},
"downloads": -1,
"filename": "nepseutils-0.4.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9ce6d7e34f477fb0cd7e3dd0cd27fa5a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 21955,
"upload_time": "2024-12-23T04:00:31",
"upload_time_iso_8601": "2024-12-23T04:00:31.214482Z",
"url": "https://files.pythonhosted.org/packages/d6/6c/ffa44102636cc51fcbbced188807a72c8d38e587696dfdb2e88f752a8c82/nepseutils-0.4.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9b7c24be7c9661e1651c84f95ad39df4cc243c4d0cb1330c6604cca1e82ecfaf",
"md5": "755eea7480762e7e8d4b93983ea846c9",
"sha256": "562297e76bec7fa3b36192c3a5ce251e170816f952657f13c4183b7d5cf6ffd7"
},
"downloads": -1,
"filename": "nepseutils-0.4.7.tar.gz",
"has_sig": false,
"md5_digest": "755eea7480762e7e8d4b93983ea846c9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 20319,
"upload_time": "2024-12-23T04:00:33",
"upload_time_iso_8601": "2024-12-23T04:00:33.423831Z",
"url": "https://files.pythonhosted.org/packages/9b/7c/24be7c9661e1651c84f95ad39df4cc243c4d0cb1330c6604cca1e82ecfaf/nepseutils-0.4.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-23 04:00:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "arpandaze",
"github_project": "nepseutils",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "nepseutils"
}
JSON
