Init project

Author: Breta01

.github/workflows/python-test.yml

@@ -0,0 +1,38 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Python test
+
+on:
+  push:
+    branches:
+      - "**"  # Triggers on commits to all branches
+  pull_request:
+    branches:
+      - "**"  # Runs on all pull requests
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.10"
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8 pytest
+        pip install .
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Test with pytest
+      run: |
+        pytest

.gitignore

@@ -0,0 +1,131 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+output/

.pre-commit-config.yaml

@@ -0,0 +1,31 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: check-yaml
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: requirements-txt-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/psf/black
+    rev: 23.3.0
+    hooks:
+      - id: black
+        language_version: python3.10
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+        name: isort (python)
+        additional_dependencies: ["toml"]
+  - repo: https://github.com/hadialqattan/pycln
+    rev: v1.2.5
+    hooks:
+      - id: pycln
+        args: [--config=pyproject.toml]
+        stages: [manual]

.vscode/settings.json

@@ -0,0 +1,28 @@
+{
+    "editor.formatOnSave": true,
+    "editor.formatOnPaste": true,
+    "files.trimTrailingWhitespace": true,
+    "files.autoSave": "onFocusChange",
+    "git.autofetch": true,
+    "[jsonc]": {
+        "editor.defaultFormatter": "vscode.json-language-features"
+    },
+    "[python]": {
+        "editor.defaultFormatter": "ms-python.black-formatter"
+    },
+    "python.formatting.provider": "black",
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
+    "pylint.args": [
+        "--rcfile=pyproject.toml"
+    ],
+    "black-formatter.args": [
+        "--config=pyproject.toml"
+    ],
+    "flake8.args": [
+        "--toml-config=pyproject.toml"
+    ],
+    "isort.args": [
+        "--settings-path=pyproject.toml"
+    ]
+}

Makefile

@@ -0,0 +1,53 @@
+.PHONY: help install lint clean test
+
+# You can specify exact version of python3 or venv name as environment variable
+PYTHON_VERSION?=python3.10
+VENV_NAME?=venv
+
+SRC_DIR=brain
+
+VENV_BIN=$(shell pwd)/${VENV_NAME}/bin
+VENV_ACTIVATE=. $(VENV_NAME)/bin/activate
+
+PYTHON=${VENV_NAME}/bin/python3
+
+
+.DEFAULT: help
+help:
+	@echo "Make file commands:"
+	@echo "    make install"
+	@echo "        Prepare complete development environment"
+	@echo "    make lint"
+	@echo "        Run pylint and flake8"
+	@echo "    make test"
+	@echo "        Run python tests of algorithm"
+	@echo "    make clean"
+	@echo "        Clean repository"
+
+install:
+#	sudo apt -y install build-essential $(PYTHON_VERSION) $(PYTHON_VERSION)-dev $(PYTHON_VERSION)-distutils
+	${PYTHON_VERSION} -m pip install -U pip
+	${PYTHON_VERSION} -m pip install virtualenv
+	make venv
+	${VENV_ACTIVATE}; pre-commit install
+	${PYTHON} -m pip install -e .
+
+
+# Runs when the file changes
+venv: $(VENV_NAME)/bin/activate
+$(VENV_NAME)/bin/activate: requirements.txt requirements-dev.txt
+	test -d $(VENV_NAME) || $(PYTHON_VERSION) -m virtualenv -p $(PYTHON_VERSION) $(VENV_NAME)
+	${PYTHON} -m pip install -U pip
+	${PYTHON} -m pip install -r requirements.txt -r requirements-dev.txt
+	touch $(VENV_NAME)/bin/activate
+
+clean:
+	find . -name '*.pyc' -exec rm --force {} +
+	rm -rf $(VENV_NAME) *.eggs *.egg-info dist build docs/_build .cache
+
+test:
+	${PYTHON} -m pytest --cov=$(SRC_DIR)
+
+lint:
+	${PYTHON} -m flake8 --toml-config=pyproject.toml $(SRC_DIR)
+	${PYTHON} -m pylint --rcfile=pyproject.toml $(SRC_DIR)

README.md

@@ -0,0 +1,33 @@
+# World Quant Brain
+
+Code for creating and submitting alphas for World Quant Brain
+
+## Set-up
+
+Install **Python 3.10** or above and install necessary dependencies:
+
+```bash
+pip install -r requirements.txt -r requirements-dev.txt
+# Install learning_mf package in editable mode
+pip install -e .
+```
+
+After that you can open and run jupyter notebooks in [`notebooks/`](./notebooks/) folder.
+
+### Make file
+
+As an alternative you can use the Makefile to set up the environment. The following command
+
+```bash
+make install
+```
+
+will create virtual environment in `venv/` folder and install all required packages.
+
+## Development
+
+For development of code and commiting into git repository, run following command before making any commits:
+
+```bash
+pre-commit install
+```

brain/__init__.py

@@ -0,0 +1,9 @@
+"""Main module of the project."""
+
+
+def main():
+    print("Test")
+
+
+if __name__ == "__main__":
+    main()