Skip to content

Commit

Permalink
Pip ready
Browse files Browse the repository at this point in the history
  • Loading branch information
kloniphani committed Apr 28, 2023
1 parent c3a2979 commit 2236100
Show file tree
Hide file tree
Showing 10 changed files with 116 additions and 5 deletions.
79 changes: 79 additions & 0 deletions EasyEquities.egg-info/PKG-INFO
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
Metadata-Version: 2.1
Name: EasyEquities
Version: 1.2.2
Summary: EasyEquities active scraper to issue trading instructions
Home-page: https://github.com/kloniphani/EasyEquities
Download-URL: https://github.com/kloniphani/EasyEquities/archive/refs/tags/v1.2.1.tar.gz
Author: Kloniphani Maxakadzi
Author-email: Kloniphani@gmail.com
License: MIT
Keywords: South Africa,Trading,EasyEQuities
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# [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.
11 changes: 11 additions & 0 deletions EasyEquities.egg-info/SOURCES.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
LICENSE
README.md
setup.cfg
setup.py
EasyEquities/__init__.py
EasyEquities/broker.py
EasyEquities.egg-info/PKG-INFO
EasyEquities.egg-info/SOURCES.txt
EasyEquities.egg-info/dependency_links.txt
EasyEquities.egg-info/requires.txt
EasyEquities.egg-info/top_level.txt
1 change: 1 addition & 0 deletions EasyEquities.egg-info/dependency_links.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

5 changes: 5 additions & 0 deletions EasyEquities.egg-info/requires.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
validators
beautifulsoup4
selenium
urllib3
webdriver_manager
1 change: 1 addition & 0 deletions EasyEquities.egg-info/top_level.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
EasyEquities
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,12 @@ print(balance)
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()
```
Expand Down
Binary file removed dist/EasyEquities-1.0.tar.gz
Binary file not shown.
Binary file added dist/EasyEquities-1.2.2.tar.gz
Binary file not shown.
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
[metadata]
description-file = README.md
description_file = README.md
16 changes: 12 additions & 4 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,14 +1,20 @@
from distutils.core import setup

# read the contents of your README file
from pathlib import Path
this_directory = Path(__file__).parent
long_description = (this_directory / "README.md").read_text()

setup(
name = 'EasyEquities', # How you named your package folder (MyLib)
packages = ['EasyEquities'], # Chose the same as "name"
version = '1.2.1', # Start with a small number and increase it with every change you make
version = '1.2.3', # Start with a small number and increase it with every change you make
license='MIT', # Chose a license from here: https://help.github.com/articles/licensing-a-repository
description = 'EasyEquities active scraper to issue trading instructions', # Give a short description about your library
author = 'Kloniphani Maxakadzi', # Type in your name
author_email = 'Kloniphani@gmail.com', # Type in your E-Mail
url = 'https://github.com/kloniphani/EasyEquities', # Provide either the link to your github or to your website
download_url = 'https://github.com/kloniphani/EasyEquities/archive/refs/tags/v1.2.1.tar.gz', # I explain this later on
download_url = 'https://github.com/kloniphani/EasyEquities/archive/refs/tags/v1.2.3.tar.gz', # I explain this later on
keywords = ['South Africa', 'Trading', 'EasyEQuities'], # Keywords that define your package best
install_requires=[ # I get to this in a second
'validators',
Expand All @@ -18,11 +24,13 @@
'webdriver_manager',
],
classifiers=[
'Development Status :: 5 - Alpha', # Chose either "3 - Alpha", "4 - Beta" or "5 - Production/Stable" as the current state of your package
'Development Status :: 5 - Production/Stable', # Chose either "3 - Alpha", "4 - Beta" or "5 - Production/Stable" as the current state of your package
'Intended Audience :: Developers', # Define that your audience are developers
'Topic :: Software Development :: Build Tools',
'License :: OSI Approved :: MIT License', # Again, pick a license
'Programming Language :: Python :: 3', #Specify which pyhton versions that you want to support
],
python_requires = ">=3.6"
python_requires = ">=3.6",
long_description=long_description,
long_description_content_type='text/markdown'
)

1 comment on commit 2236100

@vercel
Copy link

@vercel vercel bot commented on 2236100 Apr 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

easy-equities – ./

easy-equities.vercel.app
easy-equities-git-main-kloniphani.vercel.app
easy-equities-kloniphani.vercel.app

Please sign in to comment.