Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merge Dev #1

Merged
merged 7 commits into from
May 22, 2022
Merged

Merge Dev #1

merged 7 commits into from
May 22, 2022

Conversation

dmitmatveev
Copy link
Owner

  • ipynb-file with the data-analytics task-solution
  • data/ with csv-files of the data-analytics task
  • chore: Makefile, pipenv-files, .gitignore update
  • docs: add info to the README.md, INSTALL.md, DEVELOPING.md

NOTE: TODOs were provided in DEVELOPING.md:

Coding

  • (?) Move helper-functions from the .ipynb to python-script
  • (?) Try to define auto-linting and MyPy checking
  • (?) Try to add pytest for the helper-functions
  • Try to add Dockerfile

Python Versions

  • Check python3.9 support
  • Check python3.8 support
  • Check python3.7 support
  • Check python3.6 support

Docs and readability

  • Export README.md - Notions-data to the Markdown and add to the repository directly
  • Translate RU -> ENG
  • Add support/link to run the .ipynb in Google Colab
  • Add Table of Contents to the Markdown-files
  • Add Table of Contents to the .ipyng

Supported commands:
- 1. `build_kernel`
- 2. `build`
- 3. `build-notebook`
- 4. `build-lab`
- 5. `run`
- 6. `run-lab`
- 7. `update`

Most needed:  5/6 and 7
Added new:
- for ignoring macOS dir
- for ignoring PDFs
- for ignoring jupyter-lab dir
Added:
* new headers with info inside for `README.md`:
  - intro quote
  - `## Installing`
  - `## Developing`
  - `## (1) Higher Maths Test`
  - `## (2) Basic Python Definitions Test`
  - `## (3) Data Analytics - Test 3 - Pandas/Plotly`
  - `### Get Started`

* new headers with info inside for `INSTALL.md`:
  - `## Makefile usage`
  - `## How to install new python-packages`
  - `### How to activate the environment?`

* new headers with info inside for `DEVELOPING.md`:
  - `# Further TODO`
  - `### Coding`
  - `### Python Versions`
  - `### Docs and readability`
  - `# PS Try DataSpell IDE`
@dmitmatveev dmitmatveev added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels May 22, 2022
@dmitmatveev dmitmatveev merged commit b22fa0d into main May 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant