# [EasyEquities](https://www.easyequities.co.za/) Python Package
This is a Python package for interacting with the [EasyEquities](https://www.easyequities.co.za/) trading platform. It provides a simple way to log in, check account balances, and retrieve your holdings.
## Requirements
- Python 3.x
- Selenium
- pandas
- Beautiful Soup 4
- GeckoDriverManager
- Firefox
## Installation
To install, run:
```bash
pip install pandas selenium webdriver_manager beautifulsoup4
```
Then, install the package from PIP using:
```bash
pip install easyequities
```
## Usage
To use the package, you will need to import the package and create an instance of the EasyEquities class. You will need to provide your username and password as arguments. You can then use the `balance` and `holdings` methods to obtain your account balance and holdings, respectively.
Here's an example of how to use the scraper:
```python
from easyequities import EasyEquities
# Instantiate the EasyEquities class with your account credentials
ee = EasyEquities('your_username', 'your_password')
# Get your account balance
balance = ee.balance()
print(balance)
# Get your holdings
holdings = ee.holdings()
print(holdings)
# Sell your holdings
ee.sell_holdings('holding')
# Buy more holdings
ee.buy_holdings('holding', 'amount')
# Close the EasyEquities website
ee.close()
```
Note that the script uses Firefox as the web driver, so you'll need to have Firefox installed on your machine for it to work. If you don't have Firefox installed, you can download it [here](https://www.mozilla.org/en-US/firefox/new/).
## License
This code is licensed under the MIT License. See the [LICENSE](https://github.com/kloniphani/EasyEquities/blob/main/LICENSE). Feel free to use it for any purpose.
# Disclaimers
Before you start using the code, a few disclaimers:
- This code does not come with any guarantee or warranty.
- I am not a financial advisor. This work does not represent any financial advice.
- I do not recommend the use of this code for any investment decisions.
- This code is designed for personal use, and is not designed for high-volume extractions.
- Use the code at your own risk.
Raw data
{
"_id": null,
"home_page": "https://github.com/kloniphani/EasyEquities",
"name": "EasyEquities",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "South Africa,Trading,EasyEQuities",
"author": "Kloniphani Maxakadzi",
"author_email": "Kloniphani@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/e1/05/86f1828a5079719af264c03f20ee02bb746b19a3752694a15fe25d34628f/EasyEquities-1.2.3.tar.gz",
"platform": null,
"description": "# [EasyEquities](https://www.easyequities.co.za/) Python Package\r\nThis is a Python package for interacting with the [EasyEquities](https://www.easyequities.co.za/) trading platform. It provides a simple way to log in, check account balances, and retrieve your holdings.\r\n\r\n## Requirements\r\n- Python 3.x\r\n- Selenium\r\n- pandas\r\n- Beautiful Soup 4\r\n- GeckoDriverManager\r\n- Firefox\r\n\r\n## Installation\r\nTo install, run:\r\n```bash\r\npip install pandas selenium webdriver_manager beautifulsoup4\r\n```\r\nThen, install the package from PIP using:\r\n```bash\r\npip install easyequities\r\n```\r\n\r\n## Usage\r\nTo use the package, you will need to import the package and create an instance of the EasyEquities class. You will need to provide your username and password as arguments. You can then use the `balance` and `holdings` methods to obtain your account balance and holdings, respectively. \r\n\r\nHere's an example of how to use the scraper:\r\n```python\r\nfrom easyequities import EasyEquities\r\n# Instantiate the EasyEquities class with your account credentials\r\nee = EasyEquities('your_username', 'your_password')\r\n\r\n# Get your account balance\r\nbalance = ee.balance()\r\nprint(balance)\r\n\r\n# Get your holdings\r\nholdings = ee.holdings()\r\nprint(holdings)\r\n\r\n# Sell your holdings\r\nee.sell_holdings('holding')\r\n\r\n# Buy more holdings\r\nee.buy_holdings('holding', 'amount')\r\n\r\n# Close the EasyEquities website\r\nee.close()\r\n```\r\n\r\nNote that the script uses Firefox as the web driver, so you'll need to have Firefox installed on your machine for it to work. If you don't have Firefox installed, you can download it [here](https://www.mozilla.org/en-US/firefox/new/).\r\n\r\n## License\r\nThis code is licensed under the MIT License. See the [LICENSE](https://github.com/kloniphani/EasyEquities/blob/main/LICENSE). Feel free to use it for any purpose.\r\n\r\n# Disclaimers\r\nBefore you start using the code, a few disclaimers:\r\n- This code does not come with any guarantee or warranty.\r\n- I am not a financial advisor. This work does not represent any financial advice.\r\n- I do not recommend the use of this code for any investment decisions.\r\n- This code is designed for personal use, and is not designed for high-volume extractions.\r\n- Use the code at your own risk.\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "EasyEquities active scraper to issue trading instructions",
"version": "1.2.3",
"split_keywords": [
"south africa",
"trading",
"easyequities"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e10586f1828a5079719af264c03f20ee02bb746b19a3752694a15fe25d34628f",
"md5": "2af3a2793859ab235848d7f4f33770c8",
"sha256": "b272db6704f3177d2180607062e65d9c4b711375ac7c5f0b24258b78067cea82"
},
"downloads": -1,
"filename": "EasyEquities-1.2.3.tar.gz",
"has_sig": false,
"md5_digest": "2af3a2793859ab235848d7f4f33770c8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 6064,
"upload_time": "2023-04-28T11:31:56",
"upload_time_iso_8601": "2023-04-28T11:31:56.579900Z",
"url": "https://files.pythonhosted.org/packages/e1/05/86f1828a5079719af264c03f20ee02bb746b19a3752694a15fe25d34628f/EasyEquities-1.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-28 11:31:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "kloniphani",
"github_project": "EasyEquities",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "easyequities"
}
JSON
