• This repository has been archived on 14/Apr/2022
  • Stars
    star
    164
  • Rank 230,032 (Top 5 %)
  • Language
    CSS
  • License
    Apache License 2.0
  • Created almost 5 years ago
  • Updated over 2 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A fast way to turn your python function into a script

fastscript - DEPRECATED

Please use fastcore.script instead

All functionality from this module has been moved to fastcore.script. Please use that instead.

Install

Either pip install fastscript or conda install -c fastai fastscript

Overview

Sometimes, you want to create a quick script, either for yourself, or for others. But in Python, that involves a whole lot of boilerplate and ceremony, especially if you want to support command line arguments, provide help, and other niceties. You can use argparse for this purpose, which comes with Python, but it's complex and verbose.

fastscript makes life easier. There are much fancier modules to help you write scripts (we recommend Python Fire, and Click is also popular), but fastscript is very fast and very simple. In fact, it's <50 lines of code! Basically, it's just a little wrapper around argparse that uses modern Python features and some thoughtful defaults to get rid of the boilerplate.

For full details, see the docs for core.

Example

Here's a complete example - it's provided in the fastscript repo as examples/test_fastscript.py:

from fastscript import *
@call_parse
def main(msg:Param("The message", str),
         upper:Param("Convert to uppercase?", bool_arg)=False):
    print(msg.upper() if upper else msg)

When you run this script, you'll see:

$ python examples/test_fastscript.py
usage: test_fastscript.py [-h] [--upper UPPER] msg
test_fastscript.py: error: the following arguments are required: msg

As you see, we didn't need any if __name__ == "__main__", we didn't have to parse arguments, we just wrote a function, added a decorator to it, and added some annotations to our function's parameters. As a bonus, we can also use this function directly from a REPL such as Jupyter Notebook - it's not just for command line scripts!

Param

Each parameter in your function should have an annotation Param(...) (as in the example above). You can pass the following when calling Param: help,type,opt,action,nargs,const,choices,required . Except for opt, all of these are just passed directly to argparse, so you have all the power of that module at your disposal. Generally you'll want to pass at least help (since this is provided as the help string for that parameter) and type (to ensure that you get the type of data you expect). opt is a bool that defines whether a param is optional or required (positional) - but you'll generally not need to set this manually, because fastscript will set it for you automatically based on default values.

You should provide a default (after the =) for any optional parameters. If you don't provide a default for a parameter, then it will be a positional parameter.

setuptools scripts

There's a really nice feature of pip/setuptools that lets you create commandline scripts directly from functions, makes them available in the PATH, and even makes your scripts cross-platform (e.g. in Windows it creates an exe). fastscript supports this feature too. To use it, follow this example from fastscript/test_cli.py in the repo. As you see, it's basically identical to the script example above, except that we can treat it as a module. The trick to making this available as a script is to add a console_scripts section to your setup file, of the form: script_name=module:function_name. E.g. in this case we use: test_fastscript=fastscript.test_cli:main. With this, you can then just type test_fastscript at any time, from any directory, and your script will be called (once it's installed using one of the methods below).

You don't actually have to write a setup.py yourself. Instead, just use nbdev. Then modify settings.ini as appropriate for your module/script. To install your script directly, you can type pip install -e .. Your script, when installed this way (it's called an editable install, will automatically be up to date even if you edit it - there's no need to reinstall it after editing. With nbdev you can even make your module and script available for installation directly from pip and conda by running make release.

Importing Command Line Functions

Sometimes it might be useful to also be able to import command-line functions and use them as regular functions. You can do that just fine with fastscript:

from fastscript.test_cli import main
main("This can also be used as a regular imported function.", upper=True);
THIS CAN ALSO BE USED AS A REGULAR IMPORTED FUNCTION.

More Repositories

1

fastai

The fastai deep learning library
Jupyter Notebook
26,176
star
2

fastbook

The fastai book, published as Jupyter Notebooks
Jupyter Notebook
21,305
star
3

numerical-linear-algebra

Free online textbook of Jupyter notebooks for fast.ai Computational Linear Algebra course
Jupyter Notebook
10,134
star
4

courses

fast.ai Courses
Jupyter Notebook
5,571
star
5

course-v3

The 3rd edition of course.fast.ai
Jupyter Notebook
4,906
star
6

nbdev

Create delightful software with Jupyter Notebooks
Jupyter Notebook
4,829
star
7

fastpages

An easy to use blogging platform, with enhanced support for Jupyter Notebooks.
Jupyter Notebook
3,522
star
8

course-nlp

A Code-First Introduction to NLP course
Jupyter Notebook
3,414
star
9

course22

The fast.ai course notebooks
Jupyter Notebook
2,318
star
10

lm-hackers

Hackers' Guide to Language Models
Jupyter Notebook
1,756
star
11

fastprogress

Simple and flexible progress bar for Jupyter Notebook and console
Jupyter Notebook
1,083
star
12

fastcore

Python supercharged for the fastai library
Jupyter Notebook
961
star
13

imagenette

A smaller subset of 10 easily classified classes from Imagenet, and a little more French
Jupyter Notebook
934
star
14

course20

Deep Learning for Coders, 2020, the website
Jupyter Notebook
845
star
15

fastai2

Temporary home for fastai v2 while it's being developed
Jupyter Notebook
645
star
16

fastai_dev

fast.ai early development experiments
Jupyter Notebook
639
star
17

diffusion-nbs

Getting started with diffusion
Jupyter Notebook
606
star
18

ghapi

A delightful and complete interface to GitHub's amazing API
Jupyter Notebook
528
star
19

course22p2

course.fast.ai 2022 part 2
Jupyter Notebook
471
star
20

swiftai

Swift for TensorFlow's high-level API, modeled after fastai
Jupyter Notebook
457
star
21

course-v4

Please use fastbook's /clean folder instead of this
446
star
22

imagenet-fast

Python
302
star
23

nbdev_template

Template for nbdev projects
Python
290
star
24

timmdocs

Documentation for Ross Wightman's timm image model library
Jupyter Notebook
277
star
25

numerical-linear-algebra-v2

Jupyter Notebooks for Computational Linear Algebra course, taught summer 2018 in USF MSDS program
Jupyter Notebook
269
star
26

fast_template

A template for really easy blogging with GitHub Pages
HTML
250
star
27

fastdoc

Create publication-quality books from Jupyter notebooks
Jupyter Notebook
230
star
28

fastsetup

Setup all the things
Shell
219
star
29

fastdiffusion

Notes and plans for fastdiffusion course
Jupyter Notebook
202
star
30

fastai_old

OLD REPO - PLEASE USE fastai/fastai
Jupyter Notebook
179
star
31

docker-containers

Docker images for fastai
Shell
172
star
32

book_nbs

Notebooks for upcoming fastai book (draft / incomplete)
Jupyter Notebook
166
star
33

word-embeddings-workshop

This contains materials for the word embeddings workshop
HTML
123
star
34

fastec2

AWS EC2 computer management for regular folks
Python
121
star
35

execnb

Execute a jupyter notebook, fast, without needing jupyter
Jupyter Notebook
111
star
36

fastai1

v1 of the fastai library. v2 is the current version. v1 is still supported for bug fixes, but will not receive new features.
Jupyter Notebook
98
star
37

tf-fit

Fit your tensorflow model using fastai and PyTorch
Python
91
star
38

fastgpu

A queue service for quickly developing scripts that use all your GPUs efficiently
Jupyter Notebook
81
star
39

fastsql1

A bit of extra usability for sqlalchemy v2.
Jupyter Notebook
77
star
40

nbdev-template

Python
74
star
41

book.fast.ai

Information for readers of the fastai book
Jupyter Notebook
67
star
42

fastdot

A simple wrapper over `pydot` and `graphviz` which fixes some sharp edges
Jupyter Notebook
63
star
43

fastkaggle

Kaggling for fast kagglers!
Jupyter Notebook
52
star
44

nbprocess-old

Process and export Jupyter Notebooks fast (Jupyter not required)
Jupyter Notebook
52
star
45

randomized-SVD

demos for PyBay talk: Using Randomness to make code faster
Jupyter Notebook
50
star
46

fastai3

Research repo for code that may or may not end up in fastai3
Jupyter Notebook
50
star
47

pypi_template

A minimal template for creating a pypi package
Python
49
star
48

fastbook2e

The fastai book, 2nd edition (in progress)
Jupyter Notebook
46
star
49

fastdownload

Easily download, verify, and extract archives
Jupyter Notebook
44
star
50

course22-web

Website for Practical Deep Learning for Coders 2022
Jupyter Notebook
43
star
51

fastforest

A forest that is fast
C++
41
star
52

dotfiles

Vim Script
41
star
53

nbdev-vscode

TypeScript
41
star
54

bear_voila

Demo bear classifier with fastai and Voila
Jupyter Notebook
40
star
55

workflows

Composite Actions workflows for use in fastai projects
Python
39
star
56

tinykernel

A minimal Python kernel so you can run Python in your Python
Python
39
star
57

wireguard-fast

Simplified installation of WireGuard server for Ubuntu
Shell
37
star
58

minai

A miniture AI training framework for PyTorch
Jupyter Notebook
35
star
59

tinypets

Minimal JS interface to an image classifer
HTML
34
star
60

fastai-nbstripout

much faster nbstripout and autotrust notebooks local git configuration
Python
33
star
61

fastai-docs

Documentation for fastai
HTML
32
star
62

pagegraph

Draw, modify, and execute graphs using a simple python dict interface
Jupyter Notebook
29
star
63

masks4all

Make your own mask. My mask protects you. Your mask protects me.
Jupyter Notebook
26
star
64

apl-study

fast.ai APL study group notes
Jupyter Notebook
25
star
65

fastconda

Get packages onto your conda channel faster
Jupyter Notebook
22
star
66

git-tools

Tools to make git easier to use and to avoid the learning curve
Python
20
star
67

tweetrel

Use GitHub Actions to send a tweet when you make a new release
Jupyter Notebook
18
star
68

fastcgi

A fastcgi handler for Python's `socketserver` classes
Jupyter Notebook
17
star
69

fastrelease

DEPRECATED--all functionality moved to nbdev
Jupyter Notebook
15
star
70

fastpy

An easy way to start a python programming environment using GitHub Codespaces.
15
star
71

paperspace-setup

Setup a paperspace instance for fastai
Shell
14
star
72

ethics.fast.ai

The fast.ai data ethics course
Jupyter Notebook
14
star
73

fastcups

HTML
14
star
74

jupytercon-2023

Materials for "Write, Document, Test and Distribute Python Packages With Jupyter & Quarto", JupyterCon 2023.
Jupyter Notebook
14
star
75

fastlinkcheck

Check local static links and online links fast and in parallel
Jupyter Notebook
13
star
76

nbdev-index

nbdev docs lookup for a few libraries and python itself
Python
12
star
77

dlcert2

Web site source for Practical Deep Learning for Coders (2018)
Jupyter Notebook
12
star
78

Str8Pix

find the optimal rotation to correct skewed photos
Jupyter Notebook
11
star
79

dlcert1

Deep learning certificate part 1
10
star
80

cards_deck

A minimal example of nbdev based on Allen Downey's Think Python 2nd Ed
Jupyter Notebook
10
star
81

docments

Document parameters using comments
10
star
82

nbdev2

Temporary repo for nbdev2
Jupyter Notebook
7
star
83

spacy_conda

conda packages for spacy and deps
7
star
84

hugo-mathjax

Hugo with goldmark-mathjax
Jupyter Notebook
6
star
85

fastwebhook

A simple GitHub webhook server
Jupyter Notebook
6
star
86

wandbfastai

Jupyter Notebook
5
star
87

nbeverything

5
star
88

nbdev-jekyll-theme

CSS
4
star
89

nbdev_cards

A sample of how to create a deck of cards lib using nbdev
Jupyter Notebook
4
star
90

nbdev-demo

4
star
91

getcaddy

Simple approach to getting the Caddy web server
Shell
4
star
92

nbdev-spaces-demo

A demo of how to create a Hugging Face Space with gradio within a nbdev project.
Jupyter Notebook
4
star
93

fastdispatch

Wrapper for plum dispatch to make it more compatible with fastcore's typedispatch
Jupyter Notebook
3
star
94

tanishq_blog

CSS
3
star
95

docs

3
star
96

ghtop-demo

A CLI tool for showing GitHub events, written with Rich
Jupyter Notebook
3
star
97

logos

Logos for fastai for use in websites, icons, etc.
2
star
98

jb-nbdev

Exploring how nbdev may integrate with JupyterBook
Jupyter Notebook
2
star
99

nbdev-hello-world

Hello world from nbdev
Python
2
star
100

conda-recipes

Recipes for non-fastai projects that fastai provides packages for.
Python
2
star