Delete README.md
Browse files
README.md
DELETED
|
@@ -1,151 +0,0 @@
|
|
| 1 |
-
| |
|
| 2 |
-
| :-: |
|
| 3 |
-
|  |
|
| 4 |
-
| [](https://github.com/pranjal-joshi/Screeni-py/releases/latest) [](#)  [](https://github.com/pranjal-joshi/Screeni-py/blob/main/LICENSE) [](https://www.codefactor.io/repository/github/pranjal-joshi/screeni-py) [](https://en.wikipedia.org/wiki/India) [](https://github.com/pranjal-joshi/Screeni-py/blob/new-features/CONTRIBUTING.md) |
|
| 5 |
-
| [](https://github.com/pranjal-joshi/Screeni-py/actions/workflows/workflow-test.yml) [](https://github.com/pranjal-joshi/Screeni-py/actions/workflows/workflow-build-matrix.yml) |
|
| 6 |
-
|     |
|
| 7 |
-
| <img width="240" src="https://user-images.githubusercontent.com/6128978/217814499-7934edf6-fcc3-46d7-887e-7757c94e1632.png"><h2>Scan QR Code to join [Official Telegram Group](https://t.me/+0Tzy08mR0do0MzNl) for Additional Discussions</h2> |
|
| 8 |
-
|
| 9 |
-
| **YouTube** | **Use** | **Discussion** | **Bugs/Issues** | **Documentation** |
|
| 10 |
-
| :---: | :---: | :---: | :---: | :---: |
|
| 11 |
-
| [](https://www.youtube.com/playlist?list=PLsGnKKT_974J3UVS8M6bxqePfWLeuMsBi) | [](https://hub.docker.com/r/joshipranjal/screeni-py/tags) | [](https://github.com/pranjal-joshi/Screeni-py/discussions) | [](https://github.com/pranjal-joshi/Screeni-py/issues?q=is%3Aissue) | [](https://github.com/pranjal-joshi/Screeni-py/blob/main/README.md#what-is-screeni-py) |
|
| 12 |
-
| Watch our [YouTube](https://www.youtube.com/playlist?list=PLsGnKKT_974J3UVS8M6bxqePfWLeuMsBi) playlist | Get started quickly using Docker | Join/Read the Community Discussion | Raise an Issue about a Problem | Get Help about Usage |
|
| 13 |
-
|
| 14 |
-
<!-- ## [**Click to Download the Latest Version**](https://github.com/pranjal-joshi/Screeni-py/releases/latest) -->
|
| 15 |
-
|
| 16 |
-
---
|
| 17 |
-
|
| 18 |
-
## What is Screeni-py?
|
| 19 |
-
|
| 20 |
-
### A Python-based stock screener for NSE, India
|
| 21 |
-
|
| 22 |
-
**Screenipy** is an advanced stock screener to find potential breakout stocks from NSE and tell its possible breakout values. It also helps to find the stocks that are consolidating and may breakout, or the particular chart patterns that you're looking for specifically to make your decisions.
|
| 23 |
-
Screenipy is totally customizable and it can screen stocks with the settings that you have provided.
|
| 24 |
-
|
| 25 |
-
## How to use? (New Version - GUI Based)
|
| 26 |
-
|
| 27 |
-
[](https://youtu.be/2HMN0ac4H20)
|
| 28 |
-
[](https://youtu.be/JCn6z1A7INI)
|
| 29 |
-
[](https://youtu.be/T41m13iMyJc)
|
| 30 |
-
|
| 31 |
-
* Install Docker Desktop and pull the `latest` docker image from the [release](https://github.com/pranjal-joshi/Screeni-py/releases/latest) page.
|
| 32 |
-
* Checkout this [YouTube Video](https://youtu.be/2HMN0ac4H20) for detailed installation guide.
|
| 33 |
-
|
| 34 |
-
<img width="1438" alt="image" src="https://github.com/pranjal-joshi/Screeni-py/assets/6128978/2016be00-5892-4735-8ab3-5f5b70add103">
|
| 35 |
-
<img width="1438" alt="image" src="https://github.com/pranjal-joshi/Screeni-py/assets/6128978/28947290-7f42-4f6f-9fc0-0bae1ee6d6f4">
|
| 36 |
-
<img width="1438" alt="image" src="https://github.com/pranjal-joshi/Screeni-py/assets/6128978/857f8acc-a4e8-4b86-a748-c26057b0e8b1">
|
| 37 |
-
<img width="1438" alt="image" src="https://github.com/pranjal-joshi/Screeni-py/assets/6128978/360b5faa-f4f4-4df6-bec1-90985889bee6">
|
| 38 |
-
<img width="1438" alt="image" src="https://github.com/pranjal-joshi/Screeni-py/assets/6128978/99903d67-d450-4c04-93ae-1f5bb4b905a5">
|
| 39 |
-
|
| 40 |
-
## How to use? (Older Version - CLI Based - DEPRECATED)
|
| 41 |
-
|
| 42 |
-
* Download the suitable file according to your OS or install Docker Desktop and pull the `latest` docker image.
|
| 43 |
-
* Linux & Mac users should make sure that the `screenipy.bin or screenipy.run` has `execute` permission.
|
| 44 |
-
* **Run** the file. The following window will appear after a brief delay.
|
| 45 |
-
|
| 46 |
-
|
| 47 |
-
|
| 48 |
-
* **Configure** the parameters as per your requirement using `Option > 8`.
|
| 49 |
-
|
| 50 |
-
|
| 51 |
-
|
| 52 |
-
* Following are the screenshots of screening and output results.
|
| 53 |
-
|
| 54 |
-
|
| 55 |
-
|
| 56 |
-
|
| 57 |
-
|
| 58 |
-
* Once done, you can also save the results in an Excel file.
|
| 59 |
-
|
| 60 |
-
## Understanding the Result Table
|
| 61 |
-
|
| 62 |
-
The Result table contains a lot of different parameters which can be pretty overwhelming to the new users, so here's the description and significance of each parameter.
|
| 63 |
-
|
| 64 |
-
| Sr | Parameter | Description | Example |
|
| 65 |
-
|:---:|:---:|:---|:---|
|
| 66 |
-
|1|**Stock**|This is a NSE scrip symbol. If your OS/Terminal supports unicode, You can directly open **[TradingView](https://in.tradingview.com/)** charts by pressing `Ctrl+Click` on the stock name.|[TATAMOTORS](https://in.tradingview.com/chart?symbol=NSE%3ATATAMOTORS)|
|
| 67 |
-
|2|**Consolidating**|It gives the price range in which stock is trading since last `N` days. `N` is configurable and can be modified by executing `Edit User Configuration` option.|If stock is trading between price 100-120 in last 30 days, Output will be `Range = 20.0 %`|
|
| 68 |
-
|3|**Breakout (N Days)**|This is pure magic! The `BO` is Breakout level in last N days while `R` is the next resistance level if available. An investor should consider both BO & R level to decide entry/exits in their trades.|`B:302, R:313`(Breakout level is 100 & Next resistance is 102)|
|
| 69 |
-
|4|**LTP**|LTP is the Last Traded Price of an asset traded on NSE.|`298.7` (Stock is trading at this price)|
|
| 70 |
-
|5|**Volume**|Volume shows the relative volume of the recent candle with respect to 20 period MA of Volume. It could be `Unknown` for newly listed stocks.|if 20MA(Volume) is 1M and todays Volume is 2.8M, then `Volume = 2.8x`|
|
| 71 |
-
|6|**MA-Signal**|It describes the price trend of an asset by analyzing various 50-200 MA/EMA crossover strategies.|`200MA-Support`,`BullCross-50MA` etc|
|
| 72 |
-
|7|**RSI**|For the momentum traders, it describes 14-period RSI for quick decision-making about their trading plans|`0 to 100`|
|
| 73 |
-
|8|**Trend**|By using advanced algorithms, the average trendlines are computed for `N` days and their strength is displayed depending on the steepness of the trendlines. (This does NOT show any trendline on a chart, it is calculated internally)|`Strong Up`, `Weak Down` etc.|
|
| 74 |
-
|9|**Pattern**|If the chart or the candle itself forming any important pattern in the recent timeframe or as per the selected screening option, various important patterns will be indicated here.|`Momentum Gainer`, `Inside Bar (N)`,`Bullish Engulfing` etc.|
|
| 75 |
-
|
| 76 |
-
## Hack it your way
|
| 77 |
-
|
| 78 |
-
Feel free to Edit the parameters in the `screenipy.ini` file which will be generated by the application.
|
| 79 |
-
|
| 80 |
-
```ini
|
| 81 |
-
[config]
|
| 82 |
-
period = 300d
|
| 83 |
-
daystolookback = 30
|
| 84 |
-
duration = 1d
|
| 85 |
-
minprice = 30
|
| 86 |
-
maxprice = 10000
|
| 87 |
-
volumeratio = 2
|
| 88 |
-
consolidationpercentage = 10
|
| 89 |
-
shuffle = y
|
| 90 |
-
cachestockdata = y
|
| 91 |
-
onlystagetwostocks = y
|
| 92 |
-
useema = n
|
| 93 |
-
```
|
| 94 |
-
|
| 95 |
-
Try to tweak these parameters as per your trading styles. For example, If you're comfortable with weekly charts, make `duration=5d` and so on.
|
| 96 |
-
|
| 97 |
-
## Installation Guide
|
| 98 |
-
|
| 99 |
-
### YouTube Video of Detailed Installation Guide
|
| 100 |
-
|
| 101 |
-
[](https://youtu.be/2HMN0ac4H20)
|
| 102 |
-
|
| 103 |
-
[](https://youtu.be/2HMN0ac4H20)
|
| 104 |
-
|
| 105 |
-
   
|
| 106 |
-
|
| 107 |
-
### Why we shifted to Docker from the Good old EXEs?
|
| 108 |
-
|
| 109 |
-
| Executable/Binary File | Docker |
|
| 110 |
-
| :-- | :-- |
|
| 111 |
-
| [](#) |  |
|
| 112 |
-
| Download Directly from the [Release](https://github.com/pranjal-joshi/Screeni-py/releases/latest) page (DEPRECATED) | Need to Install [Docker Desktop](https://www.docker.com/products/docker-desktop/) ⚠️|
|
| 113 |
-
| May take a long time to open the app | Loads quickly |
|
| 114 |
-
| Slower screening | Performance boosted as per your CPU capabilities |
|
| 115 |
-
| You may face errors/warnings due to different CPU arch of your system ⚠️ | Compatible with all x86_64/amd64/arm64 CPUs irrespective of OS (including Mac M1/M2) |
|
| 116 |
-
| Works only with Windows 10/11 ⚠️ | Works with older versions of Windows as well |
|
| 117 |
-
| Different file for each OS | Same container is compatible with everyone |
|
| 118 |
-
| Antivirus may block this as untrusted file ⚠️ | No issues with Antivirus |
|
| 119 |
-
| Need to download new file for every update | Updates quickly with minimal downloading |
|
| 120 |
-
| No need of commands/technical knowledge | Very basic command execution skills may be required |
|
| 121 |
-
| Incompatible with Vector Database ⚠️ | Compatible with all Python libraries |
|
| 122 |
-
|
| 123 |
-
### How to set up and use Screeni-py with Docker?
|
| 124 |
-
|
| 125 |
-
1. Download and Install [Docker Desktop](https://www.docker.com/products/docker-desktop/) with default settings
|
| 126 |
-
2. If you are using Windows, update WSL (Windows subsystem for linux) by running `wsl --update` command in the command prompt
|
| 127 |
-
3. Restart your computer after installation
|
| 128 |
-
4. Open Docker Desktop and keep it as it is
|
| 129 |
-
5. Open Command Prompt (Windows) or Terminal (Mac/Linux) and run command `docker pull joshipranjal/screeni-py:latest`
|
| 130 |
-
6. Once installed, always start screenipy by running this command:
|
| 131 |
-
|
| 132 |
-
```bash
|
| 133 |
-
docker run -p 8501:8501 -p 8000:8000 joshipranjal/screeni-py:latest
|
| 134 |
-
|
| 135 |
-
OR
|
| 136 |
-
|
| 137 |
-
docker run -it --entrypoint /bin/bash joshipranjal/screeni-py:latest -c "run_screenipy.sh --cli"
|
| 138 |
-
```
|
| 139 |
-
|
| 140 |
-
Check out this [YouTube Video](https://youtu.be/2HMN0ac4H20) for a detailed installation guide.
|
| 141 |
-
|
| 142 |
-
## Contributing
|
| 143 |
-
|
| 144 |
-
* Please feel free to Suggest improvements/report bugs by creating an issue.
|
| 145 |
-
* Please follow the [Guidelines for Contributing](https://github.com/pranjal-joshi/Screeni-py/blob/new-features/CONTRIBUTING.md) while making a Pull Request.
|
| 146 |
-
|
| 147 |
-
## Disclaimer
|
| 148 |
-
|
| 149 |
-
* DO NOT use the result provided by the software 'solely' to make your trading decisions.
|
| 150 |
-
* Always backtest and analyze the stocks manually before you trade.
|
| 151 |
-
* The Author and the software will not be held liable for your losses.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|