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

chore: Move python code to its own directory #440

Merged
merged 2 commits into from
Oct 7, 2024

Conversation

thomass-dev
Copy link
Collaborator

@thomass-dev thomass-dev commented Oct 4, 2024

.
├── CONTRIBUTING.md
├── LICENSE
├── Makefile
├── README.md
├── examples
│   ├── basic_usage.ipynb
│   ├── basic_usage.py
│   ├── README.txt
│   ├── skrub_demo.ipynb
│   └── skrub_demo.py
├── skore
│   ├── pyproject.toml
│   ├── requirements-test.txt
│   ├── requirements-tools.txt
│   ├── requirements.txt
│   ├── VERSION.txt
│   ├── src
│   └── tests
└── skore-ui
    ├── index.html
    ├── package.json
    ├── package-lock.json
    ├── README.md
    ├── tsconfig.app.json
    ├── tsconfig.json
    ├── tsconfig.node.json
    ├── tsconfig.vitest.json
    ├── vite.config.lib.ts
    ├── vite.config.ts
    ├── vitest.config.ts
    ├── vitest.setup.ts
    ├── node_modules
    ├── public
    ├── src
    └── tests

@thomass-dev thomass-dev linked an issue Oct 4, 2024 that may be closed by this pull request
@thomass-dev thomass-dev force-pushed the 345-put-python-code-under-a-backend_name-directory branch 6 times, most recently from f42b9da to afcfa0e Compare October 4, 2024 13:34
Copy link
Contributor

github-actions bot commented Oct 4, 2024

Coverage Report for ./skore-ui

Status Category Percentage Covered / Total
🔵 Lines 79.87% 1461 / 1829
🔵 Statements 79.87% 1461 / 1829
🔵 Functions 44.89% 44 / 98
🔵 Branches 83.87% 130 / 155
File CoverageNo changed files found.
Generated in workflow #54 for commit ca45c47 by the Vitest Coverage Report Action

@thomass-dev thomass-dev force-pushed the 345-put-python-code-under-a-backend_name-directory branch 3 times, most recently from 4d524aa to 523280a Compare October 4, 2024 14:38
@thomass-dev thomass-dev requested a review from rouk1 October 4, 2024 14:40
@thomass-dev thomass-dev marked this pull request as ready for review October 4, 2024 14:40
@thomass-dev thomass-dev marked this pull request as draft October 4, 2024 14:41
@thomass-dev thomass-dev force-pushed the 345-put-python-code-under-a-backend_name-directory branch from 523280a to 7efa77a Compare October 4, 2024 14:43
@thomass-dev thomass-dev marked this pull request as ready for review October 4, 2024 14:49
Copy link
Contributor

@rouk1 rouk1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would like to avoid symbolic links for the readme & licence files.
They are both repo wide and are not related only to the python side of things.

Side note: I like the actual layout but maybe we could have assume the "classic" monorepo layout by adding a packages folder.

.github/workflows/release.yml Show resolved Hide resolved
.github/workflows/skore.yml Show resolved Hide resolved
@thomass-dev
Copy link
Collaborator Author

thomass-dev commented Oct 7, 2024

I would like to avoid symbolic links for the readme & licence files. They are both repo wide and are not related only to the python side of things.

Side note: I like the actual layout but maybe we could have assume the "classic" monorepo layout by adding a packages folder.

The question of the symbolic links is right (i hesitated for a long time): if we want to include a README and a license file in the python distribution package, we need to place them inside the python directory. There can't be outside the directory (ie ../).

I assumed we wouldn't duplicated those file, so i made symlinks. Should we ?

@rouk1
Copy link
Contributor

rouk1 commented Oct 7, 2024

I would like to avoid symbolic links for the readme & licence files. They are both repo wide and are not related only to the python side of things.
Side note: I like the actual layout but maybe we could have assume the "classic" monorepo layout by adding a packages folder.

The question of the symbolic links is right (i hesitated for a long time): if we want to include a README and a license file in the python distribution package, we need to place them inside the python directory. There can't be outside the directory (ie ../).

I assumed we wouldn't duplicated those file, so i made symlinks. Should we ?

Can't they be copied at build of the release ?

@thomass-dev thomass-dev marked this pull request as draft October 7, 2024 09:29
@thomass-dev thomass-dev force-pushed the 345-put-python-code-under-a-backend_name-directory branch 2 times, most recently from 7326541 to 22a1bcb Compare October 7, 2024 09:34
@thomass-dev thomass-dev marked this pull request as ready for review October 7, 2024 09:39
Copy link
Contributor

@rouk1 rouk1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove symbolic links : )

@thomass-dev thomass-dev force-pushed the 345-put-python-code-under-a-backend_name-directory branch from 22a1bcb to ca45c47 Compare October 7, 2024 10:02
@rouk1 rouk1 merged commit 796dc6a into main Oct 7, 2024
12 checks passed
@rouk1 rouk1 deleted the 345-put-python-code-under-a-backend_name-directory branch October 7, 2024 10:06
thomass-dev added a commit that referenced this pull request Dec 2, 2024
```
.
├── CONTRIBUTING.md
├── LICENSE
├── Makefile
├── README.md
├── examples
│   ├── basic_usage.ipynb
│   ├── basic_usage.py
│   ├── README.txt
│   ├── skrub_demo.ipynb
│   └── skrub_demo.py
├── skore
│   ├── pyproject.toml
│   ├── requirements-test.txt
│   ├── requirements-tools.txt
│   ├── requirements.txt
│   ├── VERSION.txt
│   ├── src
│   └── tests
└── skore-ui
    ├── index.html
    ├── package.json
    ├── package-lock.json
    ├── README.md
    ├── tsconfig.app.json
    ├── tsconfig.json
    ├── tsconfig.node.json
    ├── tsconfig.vitest.json
    ├── vite.config.lib.ts
    ├── vite.config.ts
    ├── vitest.config.ts
    ├── vitest.setup.ts
    ├── node_modules
    ├── public
    ├── src
    └── tests
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Put python code under a <backend_name> directory
3 participants