kwatmdphd / clean.jl Goto Github PK

View Code? Open in Web Editor NEW

74.0 74.0 10.0 241 KB

Command-line program for cleaning 🛀

Julia 39.20% Shell 60.80%

clean cleaner cli command-line-interface command-line-tool filesystem organizer

clean.jl's People

Contributors

Stargazers

Watchers

Forkers

tristan0x akuhnregnier kishansairam9 madhavajay tcopple colorbuffer dan-r95 joonalai acstarr

clean.jl's Issues

Remove additional properties from markdown cells

Separate cleaning python and julia

VSCode Commits screwed up things

Last two VSCode commits have messed up with the repo, please revert master to 41ae791

Use server to speed up cleaning up Julia code

Refactor, test, and release on PyPI

Speed up cleaning julia notebook

Maybe, it is supposed to be so but it takes 2 minutes to clean a notebook with 5 non-empty Julia cells (and any other except an empty one)

$ time clean_ipynb 5\ Conditionals\ and\ Recursion.ipynb
5 Conditionals and Recursion.ipynb
clean_ipynb 5\ Conditionals\ and\ Recursion.ipynb  131,02s user 1,03s system 99% cpu 2:12,97 total

Version info:

clean_ipynb master branch
python-black 19.3b0-2
python-isort 4.3.21.2-1
julia 1.2.0
JuliaFormatter v0.1.19

Add topics to the repo

Topics help to discover interesting packages. As an example, jupyter.

Add option to fail if dirty

It would be good to add an option to exit with an error code if some cleaning was needed. A bit like Prettier's --check option.

Thanks ;)

Implement a progress bar for huge notebooks

In my opinion a progressbar like would be desirable to ensure the user nothing has crashed yet

A sample implementation
can be found here

Set up `JuliaFormatter.toml`

curl https://raw.githubusercontent.com/KwatMDPhD/ComputationalEnvironment.how/main/JuliaFormatter.toml > ~/.JuliaFormatter.toml

Fix printing

When run, always prints out: "🗑️ Emptying /var/folders/z_/r2n_rt396917fl9qm_t5h7jm0000gn/T/BioLab"

Why does this require python 3.7? What would it take to support 3.6?

Debug Google colab notebook

Caught by @dan-r95

https://colab.research.google.com/github/CSAILVision/semantic-segmentation-pytorch/blob/master/notebooks/DemoSegmenter.ipynb#scrollTo=-IvAYVzTXkcP

FTBS on Debian/Testing

Hi,
I've just tried to run the following command to install Clean.jl and I run into this error:

julia --project --eval "using Pkg; Pkg.instantiate()"
┌ Error: Could not parse entry for `deps`
└ @ Pkg.Types /build/julia-CrxBG0/julia-1.5.3+dfsg/usr/share/julia/stdlib/v1.5/Pkg/src/manifest.jl:146
ERROR: MethodError: no method matching get(::Pair{String,Any}, ::String, ::Nothing)
Closest candidates are:
  get(::REPL.Terminals.TTYTerminal, ::Any, ::Any) at /build/julia-CrxBG0/julia-1.5.3+dfsg/usr/share/julia/stdlib/v1.5/REPL/src/Terminals.jl:161
  get(::Base.EnvDict, ::AbstractString, ::Any) at env.jl:80
  get(::IdDict{K,V}, ::Any, ::Any) where {K, V} at iddict.jl:86
  ...
Stacktrace:
 [1] Dict{Base.UUID,Pkg.Types.PackageEntry}(::Dict{String,Any}) at /build/julia-CrxBG0/julia-1.5.3+dfsg/usr/share/julia/stdlib/v1.5/Pkg/src/manifest.jl:135
 [2] read_manifest(::String) at /build/julia-CrxBG0/julia-1.5.3+dfsg/usr/share/julia/stdlib/v1.5/Pkg/src/manifest.jl:177
 [3] Pkg.Types.EnvCache(::Nothing) at /build/julia-CrxBG0/julia-1.5.3+dfsg/usr/share/julia/stdlib/v1.5/Pkg/src/Types.jl:299
 [4] EnvCache at /build/julia-CrxBG0/julia-1.5.3+dfsg/usr/share/julia/stdlib/v1.5/Pkg/src/Types.jl:279 [inlined]
 [5] Pkg.Types.Context() at ./util.jl:438
 [6] #instantiate#169 at /build/julia-CrxBG0/julia-1.5.3+dfsg/usr/share/julia/stdlib/v1.5/Pkg/src/API.jl:791 [inlined]
 [7] instantiate() at /build/julia-CrxBG0/julia-1.5.3+dfsg/usr/share/julia/stdlib/v1.5/Pkg/src/API.jl:791
 [8] top-level scope at none:1

I'm a real newbie as Julia is concerned.
Any help would be great
Best

Build with CI/CD to ensure prs really work

continous delivery with travis CI etc. would ensure that a merged pull request is really working (from the syntax part)
and maybe this could be combined with hosting the package on pypi.org

First try of clean_ipynb

Traceback (most recent call last):
  File "/Users/cls/anaconda3/lib/python3.7/site-packages/click/termui.py", line 372, in style
    bits.append('\033[%dm' % (_ansi_colors.index(fg) + 30))
ValueError: tuple.index(x): x not in tuple

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/Users/cls/anaconda3/bin/clean_ipynb", line 11, in <module>
    sys.exit(command_line_interface())
  File "/Users/cls/anaconda3/lib/python3.7/site-packages/click/core.py", line 722, in __call__
    return self.main(*args, **kwargs)
  File "/Users/cls/anaconda3/lib/python3.7/site-packages/click/core.py", line 697, in main
    rv = self.invoke(ctx)
  File "/Users/cls/anaconda3/lib/python3.7/site-packages/click/core.py", line 895, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/Users/cls/anaconda3/lib/python3.7/site-packages/click/core.py", line 535, in invoke
    return callback(*args, **kwargs)
  File "/Users/cls/anaconda3/lib/python3.7/site-packages/clean_ipynb/command_line_interface.py", line 27, in command_line_interface
    secho(ipynb_file_path, bg="black", fg="bright_green")
  File "/Users/cls/anaconda3/lib/python3.7/site-packages/click/termui.py", line 420, in secho
    return echo(style(text, **styles), file=file, nl=nl, err=err, color=color)
  File "/Users/cls/anaconda3/lib/python3.7/site-packages/click/termui.py", line 374, in style
    raise TypeError('Unknown color %r' % fg)
TypeError: Unknown color 'bright_green'

Rename the command line tool to be cleanipynb

IndexError: list index out of range

Hello, I want to use clean_ipynb.
But I am getting an error.
how to fix it?

clean_ipynb/clean_ipynb.py", line 120, in clean_ipynb_cell
    rem_extra_new_line = clean_lines[-2][:-1]

Shell Commands with ! causing program to crash

Support pluggable auto formatting of code blocks

My team uses https://pre-commit.com to automatically run linters and formatters on all of our code. I'm looking for something to run this on jupyter notebooks as well which is why I ran across your project.

As part of our pre-commit process we run

isort
autoflake
black
whitespace checks

it occurs to me that others may run different combinations of these. It would be great if your project could provide a way to generically run a set of linters on each notebook block.

Use join

Investigate why cleaning julia .ipynb cells with "$" fails.

Clean up the code from the recent pull requests

Change Default Clear Output to False

@KwatME Most of the people who might want to use this tool actually are interested in formatting the python code aspects. Clearing the output might not be of their interest since once they push their code to repo / share their code somewhere they want to show their results too (i.e, plots or output's like accuracy etc.). Thus I think default should be not clearing output & clearing output can be enabled through flag