Skip to content

Commit

Permalink
GitHub Action Workflow - Updating version to latest
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Sep 22, 2024
1 parent a6b3a55 commit 7433398
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 68 deletions.
64 changes: 32 additions & 32 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,42 +1,42 @@
![Title](https://raw.githubusercontent.com/pkjmesra/PKScreener/main/screenshots/logos/Logo8_1.png)

# PKScreener (# 1 Stock screener/scanner for NSE India)
| [![MADE-IN-INDIA][MADE-IN-INDIA-badge]][MADE-IN-INDIA] | [![GitHub release (latest by date)][GitHub release (latest by date)-badge]][GitHub release (latest by date)] | [![Downloads][Downloads-badge]][Downloads] | ![latest download][Latest-Downloads-badge] | [![Docker Pulls][Docker Pulls-badge]][Docker Status] |
| :-------------: | :-----------------: | :-----------------: | :-----------------: | :-----------------: |
| Platforms | [![Windows][Windows-badge]][Windows] | [![Linux][Linux-badge]][Linux] | [![Mac OS][Mac OS-badge]][Mac OS] | [![Docker Status][Docker Status-badge]][Docker Status] |
| Package / Docs | [![Documentation][Documentation-badge]][Documentation] | [![PyPI][pypi-badge]][pypi] | [![is wheel][wheel-badge]][pypi] | ![github license][github-license] |
| Tests | [![CodeFactor][Codefactor-badge]][Codefactor] | [![Coverage Status][Coverage-Status-badge]][Coverage-Status] | [![codecov][codecov-badge]][codecov] | [![After Market][After Market-badge]][After Market] |
| [![MADE-IN-INDIA][MADE-IN-INDIA-badge]][MADE-IN-INDIA] | [![GitHub release (latest by date)][GitHub release (latest by date)-badge]][GitHub release (latest by date)] | [![Downloads][Downloads-badge]][Downloads] | ![latest download][Latest-Downloads-badge] | [![Docker Pulls][Docker Pulls-badge]][Docker Status] |
| :----------------------------------------------------: | :----------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------: | :----------------------------------------------------: |
| Platforms | [![Windows][Windows-badge]][Windows] | [![Linux][Linux-badge]][Linux] | [![Mac OS][Mac OS-badge]][Mac OS] | [![Docker Status][Docker Status-badge]][Docker Status] |
| Package / Docs | [![Documentation][Documentation-badge]][Documentation] | [![PyPI][pypi-badge]][pypi] | [![is wheel][wheel-badge]][pypi] | ![github license][github-license] |
| Tests | [![CodeFactor][Codefactor-badge]][Codefactor] | [![Coverage Status][Coverage-Status-badge]][Coverage-Status] | [![codecov][codecov-badge]][codecov] | [![After Market][After Market-badge]][After Market] |

## What is PKScreener?
| Telegram Alerts | Nifty AI Prediction | Scheduling Cron Jobs | On-Demand Telegram Bot | Backtesting / Growth of 10k|
| :-------------: | :-----------------: | :------------------: | :--------------------: | :-----------: |
| Nifty screening | Volume scanners | Breakout detection | Consolidating stocks | Reversal Signals |
| Chart Patterns | CCI scanners | 2% scanners | Short-term bulls | NR4 / NR7 | Daily Releases |
| Fair Value | Mutual funds, FII data | TTM Squeeze | Golden Crossover | Death Crossover|
| RSI screening | MACD scanners | IPO Stocks | Momentum Gainers | Watchlist screening |
| Stock Performance | 52Wk-H/L Breakouts | 10 days low breakouts | Aroon Crossover | Next Day Bullish Stocks|
| Today's Breakouts | Breaking out now | Popular stocks by Mutual Funds / FIIs | Higher Highs | Lower Lows|
| F&O Stocks screening | Live 5-EMA Index Scan | Logging | Telegram Channel | Early Breakouts |
| ATR Cross | ATR Trailing Stops | Intraday Bid/Ask Build-up | Quick Backtest | Morning vs Day-close profit analysis |
| Multiple period/duration support | Daily OHLCV | Intraday OHLCV | Auomated Software Updates| NASDAQ Index Support |
| Nifty 50 | Nifty Next 50 | Nifty 100 | Nifty 200| Nifty 500 |
| Nifty Smallcap 50 | Nifty Smallcap 250 | Nifty Midcap 50 | Nifty Midcap 100| Nifty Midcap 150 |
| Nifty All 2000 | Nifty Newly Listed (IPOs in last 2 Year) | Nifty F&O Stocks | View Stock Performance| High Momentum(RSI,MFI,CCI) |
| Intraday Monitor | Scanner pinning | Stock list Pinning | VCP (Volatility Contraction Pattern)| VCP (Mark Minervini) |
| Moving Average Signals | Candle-stick Patterns | Trendline Support Stocks | Bullish/Bearish Inside Bar | Volume Spread Analysis |
| Narrow Range (NRx) Reversal | Lorentzian Classifier | PSAR and RSI reversal | Rising RSI | RSI MA Reversal |
| Upcoming CA stocks | High Dividend Stocks | Fair Value Buy Opportunities | Shareholding by number of Mutual Funds/FIIs | Bullish for next day |
| Telegram Alerts | Nifty AI Prediction | Scheduling Cron Jobs | On-Demand Telegram Bot | Backtesting / Growth of 10k | |
| :------------------------------: | :--------------------------------------: | :-----------------------------------: | :-----------------------------------------: | :----------------------------------: | -------------- |
| Nifty screening | Volume scanners | Breakout detection | Consolidating stocks | Reversal Signals | |
| Chart Patterns | CCI scanners | 2% scanners | Short-term bulls | NR4 / NR7 | Daily Releases |
| Fair Value | Mutual funds, FII data | TTM Squeeze | Golden Crossover | Death Crossover | |
| RSI screening | MACD scanners | IPO Stocks | Momentum Gainers | Watchlist screening | |
| Stock Performance | 52Wk-H/L Breakouts | 10 days low breakouts | Aroon Crossover | Next Day Bullish Stocks | |
| Today's Breakouts | Breaking out now | Popular stocks by Mutual Funds / FIIs | Higher Highs | Lower Lows | |
| F&O Stocks screening | Live 5-EMA Index Scan | Logging | Telegram Channel | Early Breakouts | |
| ATR Cross | ATR Trailing Stops | Intraday Bid/Ask Build-up | Quick Backtest | Morning vs Day-close profit analysis | |
| Multiple period/duration support | Daily OHLCV | Intraday OHLCV | Auomated Software Updates | NASDAQ Index Support | |
| Nifty 50 | Nifty Next 50 | Nifty 100 | Nifty 200 | Nifty 500 | |
| Nifty Smallcap 50 | Nifty Smallcap 250 | Nifty Midcap 50 | Nifty Midcap 100 | Nifty Midcap 150 | |
| Nifty All 2000 | Nifty Newly Listed (IPOs in last 2 Year) | Nifty F&O Stocks | View Stock Performance | High Momentum(RSI,MFI,CCI) | |
| Intraday Monitor | Scanner pinning | Stock list Pinning | VCP (Volatility Contraction Pattern) | VCP (Mark Minervini) | |
| Moving Average Signals | Candle-stick Patterns | Trendline Support Stocks | Bullish/Bearish Inside Bar | Volume Spread Analysis | |
| Narrow Range (NRx) Reversal | Lorentzian Classifier | PSAR and RSI reversal | Rising RSI | RSI MA Reversal | |
| Upcoming CA stocks | High Dividend Stocks | Fair Value Buy Opportunities | Shareholding by number of Mutual Funds/FIIs | Bullish for next day | |

### A Python-based stock screener for NSE, India.

**pkscreener** is an advanced stock screener to find potential breakout stocks from NSE and tell it's possible breakout values. It also helps to find the stocks which are consolidating and may breakout, or the particular chart patterns that you're looking specifically to make your decisions.
pkscreener is totally customizable and it can screen stocks with the settings that you have provided.

You can get daily scan results/alerts at scheduled times by subscribing to the following Telegram channel:
| Purpose | Description/link | QR Code |
| :------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| Alerts Channel | https://t.me/PKScreener > You wil receive all the major alerts on this telegram channel. These alerts are sent for all major strategy scans daily around 9:30am-10:15am and then around 4pm. You will also receive the next day's market predictions. | <img src="https://raw.githubusercontent.com/pkjmesra/PKScreener/main/screenshots/Telegram_Channel_Prod.jpg" alt="Telegram Channel" width="500"/> |
| Discussion Channel | https://t.me/PKScreeners > You can discuss with other traders and community members. | <img src="https://raw.githubusercontent.com/pkjmesra/PKScreener/main/screenshots/PKScreeners_Group.jpg" alt="Telegram Discussion Channel" width="500"/> |
| Purpose | Description/link | QR Code |
| :----------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Alerts Channel | https://t.me/PKScreener > You wil receive all the major alerts on this telegram channel. These alerts are sent for all major strategy scans daily around 9:30am-10:15am and then around 4pm. You will also receive the next day's market predictions. | <img src="https://raw.githubusercontent.com/pkjmesra/PKScreener/main/screenshots/Telegram_Channel_Prod.jpg" alt="Telegram Channel" width="500"/> |
| Discussion Channel | https://t.me/PKScreeners > You can discuss with other traders and community members. | <img src="https://raw.githubusercontent.com/pkjmesra/PKScreener/main/screenshots/PKScreeners_Group.jpg" alt="Telegram Discussion Channel" width="500"/> |

![telegram](https://raw.githubusercontent.com/pkjmesra/PKScreener/main/screenshots/telegram.png)

Expand Down Expand Up @@ -102,7 +102,7 @@ Multiple Indices to choose from:
```

Followin scanners are already implemented.
Followin scanners are already implemented.
```
0 > Full Screening (Shows Technical Parameters without any criterion)
1 > Probable Breakouts/Breakdowns 2 > Today's Breakouts/Breakdowns
Expand All @@ -124,7 +124,7 @@ Followin scanners are already implemented.
33 > Potential Profitable setups
42 > Show Last Screened Results
```
## Running Piped Scanners

Expand Down Expand Up @@ -157,11 +157,11 @@ Multiple pre-defined piped scanners
# Using docker, running within docker container
* Download and install docker desktop: https://docs.docker.com/get-docker/
* After installation, launch/run docker desktop and if it asks, login using your docker credentials.
* Launch any command line (for example, cmd on windows or terminal on Mac) and type
* Launch any command line (for example, cmd on windows or terminal on Mac) and type
```
docker pull pkjmesra/pkscreener:latest
```
Then type
Then type
```
docker run -it pkjmesra/pkscreener:latest
```
Expand All @@ -182,7 +182,7 @@ The story is similar for other low severity vulnerabilities that docker might sh

For example:

For `Windows`: See https://github.com/pkjmesra/PKScreener/blob/c1e94ba3137915cb781161fa2d5fb69129940fd3/.github/workflows/w1-workflow-build-matrix.yml#L91-L101
For `Windows`: See https://github.com/pkjmesra/PKScreener/blob/c1e94ba3137915cb781161fa2d5fb69129940fd3/.github/workflows/w1-workflow-build-matrix.yml#L91-L101

For `Mac`: Run `brew install ta-lib` assuming you have homebrew installed.

Expand Down
33 changes: 1 addition & 32 deletions pkscreener/classes/__init__.py
View file
Original file line number Diff line number Diff line change
@@ -1,32 +1 @@
"""
The MIT License (MIT)
Copyright (c) 2023 pkjmesra
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
"""
# This version must never be changed in full other than the first two components
# if at all required. The last two components of the version are assigned by the
# CI/CD pipeline. Only, ever update major.minor. Don't update other parts ever.
# The pipeline will invoke updateVersion.py which will update the versions as
# required for the package as well as this file, ReadMe.txt file as well as
# commit the changes into the main/checked-out branch.
# major.minor.dateOfRelease.pipelineJobNumber
VERSION = '0.45.20240922.580'
VERSION='0.45.20240922.582'
8 changes: 4 additions & 4 deletions pkscreener/release.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[![MADE-IN-INDIA](https://img.shields.io/badge/MADE%20WITH%20%E2%9D%A4%20IN-INDIA-orange?style=for-the-badge)](https://en.wikipedia.org/wiki/India) [![GitHub release (latest by date)](https://img.shields.io/github/v/release/pkjmesra/PKScreener?style=for-the-badge)](#) [![GitHub all releases](https://img.shields.io/github/downloads/pkjmesra/PKScreener/total?color=Green&label=Downloads&style=for-the-badge)](#) [![MADE_WITH](https://img.shields.io/badge/BUILT%20USING-PYTHON-yellow?style=for-the-badge&logo=python&logoColor=yellow)](https://www.python.org/)

## What's New?
1. [v0.45.20240922.580] release
1. [v0.45.20240922.582] release
* Find a stock in scanners. You can now look-up a stock and find out which all basic standard scanners gave out that stock in result.
* GPU enabled for running scans on computers where GPU device(s) is available
* Excel hyperlinks enabled for stocks when the results are saved/exported to excel.
Expand All @@ -23,9 +23,9 @@
## Downloads
| Operating System | Executable File |
| -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ![Windows](https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white) | **[pkscreenercli.exe](https://github.com/pkjmesra/PKScreener/releases/download/0.45.20240922.580/pkscreenercli.exe)** |
| ![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black) | **[pkscreenercli.bin](https://github.com/pkjmesra/PKScreener/releases/download/0.45.20240922.580/pkscreenercli.bin)** |
| ![Mac OS](https://img.shields.io/badge/mac%20os-D3D3D3?style=for-the-badge&logo=apple&logoColor=000000) | **[pkscreenercli.run](https://github.com/pkjmesra/PKScreener/releases/download/0.45.20240922.580/pkscreenercli.run)** ([Read Installation Guide](https://github.com/pkjmesra/PKScreener/blob/main/INSTALLATION.md#for-macos)) |
| ![Windows](https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white) | **[pkscreenercli.exe](https://github.com/pkjmesra/PKScreener/releases/download/0.45.20240922.582/pkscreenercli.exe)** |
| ![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black) | **[pkscreenercli.bin](https://github.com/pkjmesra/PKScreener/releases/download/0.45.20240922.582/pkscreenercli.bin)** |
| ![Mac OS](https://img.shields.io/badge/mac%20os-D3D3D3?style=for-the-badge&logo=apple&logoColor=000000) | **[pkscreenercli.run](https://github.com/pkjmesra/PKScreener/releases/download/0.45.20240922.582/pkscreenercli.run)** ([Read Installation Guide](https://github.com/pkjmesra/PKScreener/blob/main/INSTALLATION.md#for-macos)) |

## How to use?

Expand Down

0 comments on commit 7433398

Please sign in to comment.