PKScreener
A Python-based stock screener for NSE, India. PKScreener is an advanced free stock screener to find potential breakout stocks from NSE and show its 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.
File Explorer
Download Latest Version (.zip)- build_source.sh
- check_build_trigger.sh
- install_talib.sh
- syncbranches.sh
- talib.sh
- build_wheels.sh
- nse-holidays.json
- ta-lib-0.4.0-msvc.zip
- ta-lib-0.4.0-src.tar.gz
- TA-Lib-0.4.28.tar.gz
- ta-lib-0.6.4-src.tar.gz
- ta-lib_0.6.4_amd64.deb
- ta-lib_0.6.4_arm64.deb
- TA_Lib-0.4.19-cp39-cp39-win_amd64.whl
- TA_Lib-0.4.20-cp39-cp39-win32.whl
- TA_Lib-0.4.28-cp311-cp311-win_amd64.whl
- TA_Lib-0.4.28-cp312-cp312-win_amd64.whl
- TA_Lib-0.4.29-cp310-cp310-win32.whl
- TA_Lib-0.4.29-cp310-cp310-win_amd64.whl
- TA_Lib-0.4.29-cp311-cp311-win32.whl
- TA_Lib-0.4.29-cp311-cp311-win_amd64.whl
- TA_Lib-0.4.29-cp312-cp312-win32.whl
- TA_Lib-0.4.29-cp312-cp312-win_amd64.whl
- ta_lib-0.6.0-cp312-cp312-win32.whl
- ta_lib-0.6.0-cp312-cp312-win_amd64.whl
- ta_lib-0.6.0-cp312-cp312-win_arm64.whl
- ta_lib-0.6.0-cp313-cp313-win32.whl
- ta_lib-0.6.0-cp313-cp313-win_amd64.whl
- bug_report.md
- feature_request.md
- deploy-docs.yml
- fetch-fresh-data.py
- fetch_ticks_from_bot.py
- gh-pages-deployment.yml
- githubutilities.py
- scan_queue_manager.py
- squash.py
- subworkflows.py
- sync_local_candles.py
- ticks_to_pickle.py
- updateVersion.py
- w-data-publisher.yml
- w-data-warmup.yml
- w-local-candle-sync.yml
- w-scan-worker-pool.yml
- w-Trial.yml
- w0-workflow-ci-tests.yml
- w1-workflow-build-matrix.yml
- w10-workflow-features-test.yml
- w10-workflow-generic.yml
- w11-workflow-test-coverage.yml
- w11.1-workflow-test-coverage-UbuntuOnly.yml
- w12-workflow-backtests-trigger.yml
- w13-workflow-backtest_generic.yml
- w14-workflow-stale.yml
- w15-docker-image.yml
- w15-workflow-pkkite-pickle.yml
- w16-workflow-hist-scans-trigger.yml
- W17-ai-pr-reviewer.yml
- w18-workflow-prod-barometer.yml
- w18-workflow-sub-data.yml
- w19-workflow-alert-scanner-job-reset.yaml
- w2-workflow-python-publish.yml
- w20-workflow-alert-scanner-jobs-trigger.yaml
- w3-workflow-bot.yml
- w4-workflow-prod-scans_1.yml
- w5-workflow-prod-scans_Tests.yml
- w6-workflow-prod-scans_AllInOne.yml
- w7-workflow-prod-scans-trigger.yml
- w8-workflow-alert-scan_generic.yml
- w9-workflow-download-data.yml
- workflowtriggers.py
- FUNDING.yml
- layout.html
- .nojekyll
- custom.css
- INDEX.md
- API_INDEX.md
- API_REFERENCE.md
- ARCHITECTURE.md
- CHANGELOG.md
- CODE_OF_CONDUCT.md
- Configuration.md
- CONTRIBUTING.md
- CreatingBot.md
- custom.css
- cve-fixes.txt
- DEVELOPER_GUIDE.md
- Disclaimer.txt
- FAQ.md
- GettingStarted.md
- GLOSSARY.md
- HIGH_PERFORMANCE_DATA.md
- INSTALLATION.md
- PKScreener-Contributors.txt
- README.md
- RELEASE_PROCESS.md
- requirements-dev.txt
- requirements.txt
- SCALABLE_ARCHITECTURE.md
- SCAN_WORKFLOWS.md
- SUMMARY.md
- TESTING.md
- UnderstandingResults.md
- book.toml
- How-to-run-piped-scanners.mp4
- API_REFERENCE.md
- ARCHITECTURE.md
- conf.py
- DEVELOPER_GUIDE.md
- Disclaimer.txt
- generate_api_docs.py
- HIGH_PERFORMANCE_DATA.md
- index.rst
- install_mdbook.sh
- LICENSE-Others
- migrate_to_mdbook.py
- README.md
- RELEASE_PROCESS.md
- requirements.txt
- run_migration.sh
- SCALABLE_ARCHITECTURE.md
- SCAN_WORKFLOWS.md
- TESTING.md
- IPO1.png
- IPO2.png
- IPO3.png
- MomentumGainer.png
- __init__.py
- BotHandlers.py
- __init__.py
- PKCliRunner.py
- __init__.py
- signals.py
- __init__.py
- AdaptiveConsumerManager.py
- ArtTexts.py
- AssetsManager.py
- Backtest.py
- BacktestHandler.py
- BacktestUtils.py
- Barometer.py
- CandlePatterns.py
- Changelog.py
- ConfigManager.py
- ConsoleMenuUtility.py
- ConsoleUtility.py
- CoreFunctions.py
- DataLoader.py
- ExecuteOptionHandlers.py
- Fetcher.py
- GlobalStore.py
- ImageUtility.py
- keys.py
- MainLogic.py
- MarketMonitor.py
- MarketStatus.py
- MenuManager.py
- MenuNavigation.py
- MenuOptions.py
- NotificationService.py
- OtaUpdater.py
- OutputFunctions.py
- PKAnalytics.py
- PKDataService.py
- PKDemoHandler.py
- PKMarketOpenCloseAnalyser.py
- PKPremiumHandler.py
- PKScanRunner.py
- PKScheduledTaskProgress.py
- PKScheduler.py
- PKScreenerMain.py
- PKSpreadsheets.py
- Pktalib.py
- PKTask.py
- PKUserRegistration.py
- Portfolio.py
- PortfolioXRay.py
- ResultsLabeler.py
- ResultsManager.py
- ScreeningStatistics.py
- StockScreener.py
- tableSorting.js
- TelegramNotifier.py
- UserMenuChoicesHandler.py
- Utility.py
- WorkflowManager.py
- best_model_0.7438acc.h5
- nifty_model.h5
- nifty_model.pkl
- nifty_model_v2.h5
- nifty_model_v2.pkl
- nifty_model_v3.h5
- nifty_model_v3.pkl
- __init__.py
- courbd.ttf
- globals.py
- MainApplication.py
- pkscreener.ini
- pkscreenerbot.py
- pkscreenercli.py
- release.md
- requirements.txt
- watchlist_template.xlsx
- debug_config.ini
- defaults.json
- EQUITY_L.csv
- ind_nifty100list.csv
- ind_nifty200list.csv
- ind_nifty500list.csv
- ind_nifty50list.csv
- ind_niftymidcap100list.csv
- ind_niftymidcap150list.csv
- ind_niftymidcap50list.csv
- ind_niftynext50list.csv
- ind_niftysmallcap100list.csv
- ind_niftysmallcap250list.csv
- ind_niftysmallcap50list.csv
- NSE_FO_SosScheme.csv
- author.jpeg
- Logo1.png
- Logo10.png
- Logo11.png
- Logo12.png
- Logo13.png
- Logo14.png
- Logo15.png
- Logo16.png
- Logo17.png
- Logo18.png
- Logo19.png
- Logo2.png
- Logo20.png
- Logo21.png
- Logo22.png
- Logo23.png
- Logo24.png
- Logo25.png
- Logo26.png
- Logo27.png
- Logo28.png
- Logo29.png
- Logo3.png
- Logo30.png
- Logo31.png
- Logo32.png
- Logo33.png
- Logo34.png
- Logo35.png
- Logo36.png
- Logo37.png
- Logo38.png
- Logo39.png
- Logo4.png
- Logo40.png
- Logo41.png
- Logo42.png
- Logo43.png
- Logo44.png
- Logo45.png
- Logo46.png
- Logo47.png
- Logo48.png
- Logo49.png
- Logo5.png
- Logo50.png
- Logo51.png
- Logo52.png
- Logo6.png
- Logo7.png
- Logo8.png
- Logo8_1.png
- Logo9.png
- LogoWM.png
- alerts.png
- backtest.png
- bot.gif
- config.png
- G10k.png
- G10k_Sum.png
- home.png
- icon.ico
- logo.png
- menu.png
- menu_level2.png
- menu_level3.png
- NSE_Logo.svg
- PKScreeners_Group.jpg
- result_analysis.png
- results.png
- screening.png
- telegram.png
- Telegram_Channel_Prod.jpg
- title.png
- auto_docstring_with_ai.py
- cli_options.py
- setup_docstring_generator.sh
- additional_coverage_test.py
- archiver_test.py
- asserters.py
- AssetsManager_comprehensive_test.py
- AssetsManager_test.py
- backtest_test.py
- BacktestHandler_comprehensive_test.py
- BacktestHandler_feature_test.py
- BacktestHandler_test.py
- BacktestUtils_test.py
- Barometer_test.py
- bot_menu_integration_test.py
- BotHandlers_comprehensive_test.py
- BotHandlers_feature_test.py
- CandlePatterns_test.py
- code_path_coverage_test.py
- comprehensive_coverage_test.py
- comprehensive_integration_test.py
- comprehensive_module_test.py
- ConfigManager_comprehensive_test.py
- Configmanager_test.py
- console_menu_integration_test.py
- ConsoleMenuUtility_coverage_test.py
- ConsoleMenuUtility_test.py
- ConsoleUtility_test.py
- CoreFunctions_test.py
- coverage_boost_test.py
- coverage_enhancement_test.py
- DataLoader_comprehensive_test.py
- DataLoader_test.py
- DateSorted.html
- deep_coverage_test.py
- deep_screening_test.py
- end_to_end_flow_test.py
- ExecuteOptionHandlers_test.py
- feature_workflows_test.py
- Fetcher_comprehensive_test.py
- Fetcher_coverage_test.py
- Fetcher_test.py
- final_push_coverage_test.py
- Fixture.json
- globals_test.py
- GlobalStore_comprehensive_test.py
- GlobalStore_coverage_test.py
- GlobalStore_test.py
- high_impact_coverage_test.py
- ImageUtility_test.py
- integration_mainlogic_test.py
- integration_menunavigation_test.py
- integration_notification_test.py
- integration_stockscreener_test.py
- intensive_code_coverage_test.py
- intensive_coverage_test.py
- interactive_flow_test.py
- keys_coverage_test.py
- logger_test.py
- low_coverage_modules_test.py
- MainLogic_comprehensive_test.py
- MarketMonitor_test.py
- MarketStatus_coverage_test.py
- MarketStatus_test.py
- mega_coverage_test.py
- menu_manager_comprehensive_test.py
- menu_stockscreener_handlers_test.py
- MenuManager_comprehensive_test.py
- MenuNavigation_comprehensive_test.py
- MenuOptions_coverage_test.py
- Menuoptions_test.py
- method_specific_test.py
- module_internals_test.py
- NotificationService_test.py
- OTAUpdater_test.py
- OutputFunctions_test.py
- PKAnalytics_coverage_test.py
- PKCliRunner_test.py
- PKDataService_coverage_test.py
- PKDemoHandler_test.py
- PKMarketOpenCloseAnalyser_test.py
- PKMultiProcessorClient_test.py
- PKPremiumHandler_test.py
- PKScanRunner_comprehensive_test.py
- PKScheduledTaskProgress_test.py
- PKScheduler_coverage_test.py
- PKScheduler_test.py
- pkscreenerbot_test.py
- pkscreenercli_comprehensive_test.py
- pkscreenercli_test.py
- pkscreenerFunctional_X_12_test.py
- pkscreenerFunctional_X_1_test.py
- pkscreenerFunctional_X_8_test.py
- PKScreenerMain_comprehensive_test.py
- PKTaLib_test.py
- PKTask_coverage_test.py
- PKUserRegistration_test.py
- PortfolioXRay_test.py
- pytest.ini
- refactored_modules_test.py
- RequestsMocker.py
- ResultsLabeler_test.py
- ResultsManager_comprehensive_test.py
- ResultsManager_feature_test.py
- ResultsManager_test.py
- screening_additional_test.py
- screening_methods_deep_test.py
- screening_statistics_comprehensive_test.py
- screening_statistics_deep_test.py
- ScreeningStatistics_test.py
- sharedmock.py
- signals_coverage_test.py
- signals_test.py
- StockScreener_comprehensive_test.py
- StockScreener_test.py
- StockSorted.html
- targeted_coverage_test.py
- Telegram_test.py
- TelegramNotifier_comprehensive_test.py
- TelegramNotifier_feature_test.py
- TelegramNotifier_test.py
- test_data_fallback_e2e.py
- test_data_flow_e2e.py
- tick_data_freshness_test.py
- ultra_coverage_test.py
- UserMenuChoicesHandler_coverage_test.py
- Utility_comprehensive_test.py
- Utility_coverage_test.py
- Utility_test.py
- workflowManager_test.py
- yahoo_response.txt
- .bandit
- .coveragerc
- .gitignore
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- cve-fixes.txt
- Disclaimer.txt
- Dockerfile
- Dockerfile_base
- INSTALLATION.md
- LICENSE
- PKScreener-Contributors.txt
- pkscreener.ini
- README.md
- readthedocs.yaml
- requirements-dev.txt
- requirements.txt
- ruff.toml
- setup.cfg
- setup.py
- tos.txt
# Installation Guide
1. Get the code
git clone https://github.com/pkjmesra/PKScreener
Downloads the entire project code from GitHub to your computer.
cd PKScreener
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker pull pkjmesra/pkscreener:latest
Type this command into your terminal and run it.
docker run -it pkjmesra/pkscreener:latest
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
Pulled directly from this repo's README.
3. Python
EasyPrerequisites
pip install -r pkscreener/requirements.txt
Installs the Python libraries listed in requirements.txt (or similar).
python <์คํํ ํ์ผ๋ช
>.py # README์์ ์ ํํ ์คํ ํ์ผ๋ช
์ ํ์ธํ์ธ์
Runs the Python script (or module).
If it runs without errors and prints output in the terminal, it worked.
// repository documentation
Was this content helpful?
(0 ratings)