pydanny / dj-notebook Goto Github PK

Describe the bug

Only four section headers are in the TOC, but there are six or seven items in total

Maybe break up usage to have diagrams in a new page?

To Reproduce

Go go https://dj-notebook.readthedocs.io/en/latest/usage/

Screenshots

Our current test coverage on September 30th is 52%:

Name                            Stmts   Miss  Cover   Missing
-------------------------------------------------------------
src/dj_notebook/__init__.py        13      3    77%   28-30
src/dj_notebook/shell_plus.py      44     26    41%   24-38, 43-51, 55, 60-67, 80-85, 89-91
tests/__init__.py                   0      0   100%
tests/test_dj_notebook.py           4      0   100%
-------------------------------------------------------------
TOTAL                              61     29    52%

Any improvement that increases the total percentage by at least 1% qualifies for hacktoberfest.

• Installing & running the project
• Running tests
• Code style guidelines & tools used by your project
• Testing requirements for new code, code coverage tools, CI, etc.
• PR templates
• Issues marked as beginner friendly
• Contributing documentation?

Current tests don't really check anything but should at least be passing

This will make views on models with many connections easier

Is your feature request related to a problem? Please describe.

Showing the relationships from one model to others would be awesome

Tiny change to make to:

• README.md
• docs/intro.md

Is your feature request related to a problem? Please describe.

We want to make it MUCH easier to read CSVs

Describe the solution you'd like

Provide text and file options for the plus.read_frame method

Some of the other tools in this space are awesome. Certainly on the graphing side:

• https://github.com/meshy/django-schema-graph
• https://github.com/LegoStormtroopr/django-spaghetti-and-meatballs

Is your feature request related to a problem? Please describe.

I want to be able to create a mermaid diagram and have a function that renders it.

Describe the solution you'd like

This API might work:

plus.mermaid(
"""
flowchart LR
    step1 --> step2
"""
)

Describe the bug

Code shouldn't know there might be tests. However, to get tests to work I hacked this into place.

Expected behavior

There should be no check for tests in regular code.

Is your feature request related to a problem? Please describe.

vizjs handles large datasets better

Describe the solution you'd like

Should load the models.

Describe alternatives you've considered

Mermaidjs is limited in how it handles large sets

Is your feature request related to a problem? Please describe.

Determining changelog data is messy. It would be good to have something as sweet as this: https://github.com/tiangolo/latest-changes

Describe the solution you'd like

Implement https://github.com/tiangolo/latest-changes for this project

Describe alternatives you've considered

Our current system is a lot of make work with inelegant steps.

Is your feature request related to a problem? Please describe.

Types become a bit simpler to use from Python 3.10 up due to the pipe "|" operator. To simplify adding of type hints and demonstrate that this is a modern tool, we need to remove Python 3.9

Describe the solution you'd like

Remove CI and pyproject.toml support for Python 3.9

Port from Kraken

I like ruff's version of things, also speed.

Is your feature request related to a problem? Please describe.

Right now our dependencies are entirely unpinned.

Describe the solution you'd like

Pin to the current version? I'm worried then that people on not-quite-new projects will have installation issues.

Is your feature request related to a problem? Please describe.

Right now the home page of the docs doesn't really show off what the project can do.

Describe the solution you'd like

• Convert the index file to .ipynb
• Add an example of one of the charts (diagram or model_graph)

Is your feature request related to a problem? Please describe.

Always be on the bleeding edge

Reference: https://www.jetbrains.com/help/pycharm/jupyter-notebook-support.html

• Needs to provide instructions for using dj-notebook with pycharm
• Needs to be a pull request for a new file in the docs folder, not an external article.
• Must not include any other content except for instructions on how to use dj-notebook with pycharm
• Direct copies of existing content will be rejected

Is your feature request related to a problem? Please describe.

He built django-pandas, which we use.

Nothing against poetry, we want to stay with vanilla packaging.

Once complete open a pull request linking to your video that you create demonstrating usage of dj-notebook. Youtube is preferred, but other hosts that aren't spammy will be accepted.

Up to 5 people can submit videos.

• Video: LINK HERE ADDED BY MAINTAINER
• Video: LINK HERE ADDED BY MAINTAINER
• Video: LINK HERE ADDED BY MAINTAINER
• Video: LINK HERE ADDED BY MAINTAINER
• Video: LINK HERE ADDED BY MAINTAINER

Anyone at Kraken Tech who has contributed to this before the creation of the repo needs proper attribution.

Because this is a mix of Python and Jupyter, maybe use https://jupyterbook.org?

Otherwise I'm good with either sphinx or material for mkdocs

Would be great if this did at least one of the following:

• Handled paths without user interaction. Not sure if that is possible
• Introspected the manage.py file to determine settings path
• Used some other method to make path management easier, especially for beginners

Is your feature request related to a problem? Please describe.

Activation is now sophisticated enough to need its own page

Describe the solution you'd like

Create docs/activation.md and include all three options.

The link in install.md to the pycharm documentation points to "/pycharm" and should point to "../pycharm"

PR incoming to fix it.

Is your feature request related to a problem? Please describe.

Currently all relations are a line. We need to fix that.

Describe the solution you'd like

• Abstract relations probably shouldn't be visible
• One-to-Many and Many-to-Many should be represented with typical arrow types, or have some other notation to delineate different types of relations

Is your feature request related to a problem? Please describe.

Right now there's a surfeit of items that cause mypy to fail

Describe the solution you'd like

• Add types everywhere
• Ignore the test project
• Add to make lint

• Needs to provide instructions for using dj-notebook with VSCode
• Needs to be a pull request for a new file in the docs folder, not an external article.
• Must not include any other content except for instructions on how to use dj-notebook with VScode

Is your feature request related to a problem? Please describe.

In our book we mention that the shell and shell_plus should not be run in production.

Describe the solution you'd like

This should use both warning.warn and send a red message to the shell.

• https://github.com/mdaines/viz-js
• https://vueflow.dev
• https://anywidget.dev/

Talk to @remiconnesson

Is your feature request related to a problem? Please describe.

Rather than use our own solution, let's leverage @meshy's solution here

Describe the solution you'd like

Meshy's design is similar to what I was planning to evolve dj-notebook to, which is a proper typed system of edge and node objects. Currently we are using lists and sets, which works but is harder on presentation. He also accounts for a number of edge cases.

Really helps that the design and implementation are elegant and very well done.

It's sub par and needs improvement

Is your feature request related to a problem? Please describe.

Right now it's done alphabetically, but it would be better if the graphed model was centered.

Example file diff from another project https://github.com/pydanny/simplicity/pull/17/files

The project could really use a social media logo. Taking submissions for the next 30 days.

Multiple submissions to be considered and multiple people can be assigned to the ticket, so please don't overwork yourself on this item. I'm not looking for anything fancy.

Is your feature request related to a problem? Please describe.

Our formal docs aren't appearing nicely.

Describe the solution you'd like

Implement https://squidfunk.github.io/mkdocs-material/plugins/social/

This ticket might offend purists, but our purposes class diagrams simply aren't as intuitive as simple flowcharts.

classDiagram
  A <|-- B
  B <|-- C

To this style:

flowchart TD
  A --> B
  B --> C

Note: We could change the direction, but I'm not certain that's a good idea either.

Contributor note: This ticket requires knowledge of mermaid.

Is your feature request related to a problem? Please describe.

This was inspired by code in Kraken.

Describe the solution you'd like

A some text to explain the history

Assuming this:

from dj_notebook import activate
plus = activate('path.to.settings')
users = plus.Users.objects.all()

This is the API I want implemented:

plus.read_frame(users)

Pseudocode

This might be what is necessary to add to the Plus class:

from django_pandas.io import read_frame
    <snip>

class Plus:
    <snip>
    def read_frame(self, qs: Queryset) -> pd.Dataframe:
        return read_frame(qs)

Following the pattern set in the PyCharm setup, document using this library with emacs

• Needs to provide instructions for using dj-notebook with emacs
• Needs to be a pull request for a new file in the docs folder, not an external article.
• Must not include any other content except for instructions on how to use dj-notebook with emacs
• Direct copies of existing content will be rejected

Resources:

• Connector: https://github.com/emacs-jupyter/jupyter

Is your feature request related to a problem? Please describe.

dj-notebook's Plus.print() function is provides a list of all features imported from django-extensions' shell_plus feature. However, it is impossible to read

Describe the solution you'd like

Use a dataframe or something else to better display the results

Once complete open a pull request linking to your original content that you create demonstrating usage of dj-notebook. Blogs, newsletters, dev.to, medium, or other methods apply.

Up to 5 people can submit articles, and I'll assign more than one to the ticket.

• Article: LINK HERE ADDED BY MAINTAINER
• Article: LINK HERE ADDED BY MAINTAINER
• Article: LINK HERE ADDED BY MAINTAINER
• Article: LINK HERE ADDED BY MAINTAINER
• Article: LINK HERE ADDED BY MAINTAINER

Describe the bug

Everything is lower cased

To Reproduce

from dj_notebook import activate
plus = activate('sdasdasdad)

plus.graph_model(plus.User)

Expected behavior

The models should be capitalized correctly.

Screenshots