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

Add Bowler demo link in README #112

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,10 @@ cd bowler
python setup.py install
```

Bowler in action
-------

[![asciicast](https://asciinema.org/a/txpYgkb4tdQxvK2od9evzlVov.svg)](https://asciinema.org/a/txpYgkb4tdQxvK2od9evzlVov)

License
-------
Expand Down
3 changes: 3 additions & 0 deletions website/.docusaurus/client-modules.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export default [
require("infima/dist/css/default/default.css"),
];
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"permalink": "/blog/2018/08/24/launch",
"source": "@site/blog/2018-08-24-launch.md",
"description": "We are excited to announce Bowler, the safe refactoring tool for modern Python!",
"date": "2018-08-24T00:00:00.000Z",
"tags": [],
"title": "Introducing Bowler"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"permalink": "/blog",
"page": 1,
"postsPerPage": 10,
"totalPages": 1,
"totalCount": 1,
"previousPage": null,
"nextPage": null
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"id": "api-commands",
"title": "CLI Commands",
"description": "Bowler provides a command line tool to simplify the process of testing and",
"source": "@site/../docs/api-commands.md",
"permalink": "/docs/api-commands",
"sidebar": "docs",
"next": {
"title": "Developing Bowler",
"permalink": "/docs/dev-intro"
},
"previous": {
"title": "Modifiers",
"permalink": "/docs/api-modifiers"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"id": "api-filters",
"title": "Filters",
"description": "Filters in Bowler are intermediate functions that optionally restrict the set of",
"source": "@site/../docs/api-filters.md",
"permalink": "/docs/api-filters",
"sidebar": "docs",
"next": {
"title": "Modifiers",
"permalink": "/docs/api-modifiers"
},
"previous": {
"title": "Selectors",
"permalink": "/docs/api-selectors"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"id": "api-modifiers",
"title": "Modifiers",
"description": "Modifiers in Bowler are functions that modify, add, remove, or replace syntax tree",
"source": "@site/../docs/api-modifiers.md",
"permalink": "/docs/api-modifiers",
"sidebar": "docs",
"next": {
"title": "CLI Commands",
"permalink": "/docs/api-commands"
},
"previous": {
"title": "Filters",
"permalink": "/docs/api-filters"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"id": "api-query",
"title": "Queries",
"description": "Bowler provides a \"fluent\" `Query` API for building and executing refactoring scripts.",
"source": "@site/../docs/api-query.md",
"permalink": "/docs/api-query",
"sidebar": "docs",
"next": {
"title": "Selectors",
"permalink": "/docs/api-selectors"
},
"previous": {
"title": "Usage",
"permalink": "/docs/basics-usage"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"id": "api-selectors",
"title": "Selectors",
"description": "Selectors are defined using the **lib2to3** pattern syntax to search the syntax tree",
"source": "@site/../docs/api-selectors.md",
"permalink": "/docs/api-selectors",
"sidebar": "docs",
"next": {
"title": "Filters",
"permalink": "/docs/api-filters"
},
"previous": {
"title": "Queries",
"permalink": "/docs/api-query"
}
}
92 changes: 92 additions & 0 deletions website/.docusaurus/docusaurus-plugin-content-docs/docs-b5f.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
{
"docsSidebars": {
"docs": [
{
"type": "category",
"label": "Basics",
"items": [
{
"type": "link",
"label": "Introduction",
"href": "/docs/basics-intro"
},
{
"type": "link",
"label": "Refactoring",
"href": "/docs/basics-refactoring"
},
{
"type": "link",
"label": "Setup",
"href": "/docs/basics-setup"
},
{
"type": "link",
"label": "Usage",
"href": "/docs/basics-usage"
}
]
},
{
"type": "category",
"label": "API Reference",
"items": [
{
"type": "link",
"label": "Queries",
"href": "/docs/api-query"
},
{
"type": "link",
"label": "Selectors",
"href": "/docs/api-selectors"
},
{
"type": "link",
"label": "Filters",
"href": "/docs/api-filters"
},
{
"type": "link",
"label": "Modifiers",
"href": "/docs/api-modifiers"
},
{
"type": "link",
"label": "CLI Commands",
"href": "/docs/api-commands"
}
]
},
{
"type": "category",
"label": "Contributing",
"items": [
{
"type": "link",
"label": "Developing Bowler",
"href": "/docs/dev-intro"
},
{
"type": "link",
"label": "Roadmap to the Future",
"href": "/docs/dev-roadmap"
}
]
}
]
},
"permalinkToSidebar": {
"/docs/api-commands": "docs",
"/docs/api-filters": "docs",
"/docs/api-modifiers": "docs",
"/docs/api-query": "docs",
"/docs/api-selectors": "docs",
"/docs/basics-intro": "docs",
"/docs/basics-setup": "docs",
"/docs/basics-usage": "docs",
"/docs/dev-intro": "docs",
"/docs/dev-roadmap": "docs",
"/docs/basics-refactoring": "docs"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"id": "basics-intro",
"title": "Introduction",
"description": "## What is Bowler?",
"source": "@site/../docs/basics-intro.md",
"permalink": "/docs/basics-intro",
"sidebar": "docs",
"next": {
"title": "Refactoring",
"permalink": "/docs/basics-refactoring"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"id": "basics-refactoring",
"title": "Refactoring",
"description": "Bowler builds on top of the Concrete Syntax Tree (CST) provided by **lib2to3** in the",
"source": "@site/../docs/basics-refactoring.md",
"permalink": "/docs/basics-refactoring",
"sidebar": "docs",
"next": {
"title": "Setup",
"permalink": "/docs/basics-setup"
},
"previous": {
"title": "Introduction",
"permalink": "/docs/basics-intro"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"id": "basics-setup",
"title": "Setup",
"description": "## Installing Bowler",
"source": "@site/../docs/basics-setup.md",
"permalink": "/docs/basics-setup",
"sidebar": "docs",
"next": {
"title": "Usage",
"permalink": "/docs/basics-usage"
},
"previous": {
"title": "Refactoring",
"permalink": "/docs/basics-refactoring"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"id": "basics-usage",
"title": "Usage",
"description": "Bowler provides two primary mechanisms for refactoring. It provides a",
"source": "@site/../docs/basics-usage.md",
"permalink": "/docs/basics-usage",
"sidebar": "docs",
"next": {
"title": "Queries",
"permalink": "/docs/api-query"
},
"previous": {
"title": "Setup",
"permalink": "/docs/basics-setup"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"id": "dev-intro",
"title": "Developing Bowler",
"description": "We want to make contributing to this project as easy and transparent as",
"source": "@site/../docs/dev-intro.md",
"permalink": "/docs/dev-intro",
"sidebar": "docs",
"next": {
"title": "Roadmap to the Future",
"permalink": "/docs/dev-roadmap"
},
"previous": {
"title": "CLI Commands",
"permalink": "/docs/api-commands"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"id": "dev-roadmap",
"title": "Roadmap to the Future",
"description": "Bowler is still a very young project. There are many ways in which it could improve and",
"source": "@site/../docs/dev-roadmap.md",
"permalink": "/docs/dev-roadmap",
"sidebar": "docs",
"previous": {
"title": "Developing Bowler",
"permalink": "/docs/dev-intro"
}
}
69 changes: 69 additions & 0 deletions website/.docusaurus/docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
export default {
"plugins": [],
"themes": [],
"customFields": {},
"themeConfig": {
"navbar": {
"title": "Bowler",
"logo": {
"alt": "Bowler",
"src": "img/logo/Bowler_FullColor.svg"
},
"links": [
{
"to": "docs/basics-intro",
"label": "Getting Started",
"position": "right"
},
{
"to": "docs/api-query",
"label": "API Reference",
"position": "right"
},
{
"to": "docs/dev-roadmap",
"label": "Roadmap",
"position": "right"
},
{
"href": "https://github.com/facebookincubator/bowler",
"label": "GitHub",
"position": "right"
}
]
},
"footer": {
"logo": {
"alt": "Facebook Open Source Logo",
"src": "img/oss_logo.png"
},
"copyright": "Copyright © 2019 Facebook, Inc."
}
},
"title": "Bowler",
"tagline": "Safe code refactoring for modern Python",
"url": "https://pybowler.io",
"baseUrl": "/",
"projectName": "bowler",
"organizationName": "facebookincubator",
"favicon": "img/favicon/Oddy.png",
"scripts": [
"https://buttons.github.io/buttons.js"
],
"presets": [
[
"@docusaurus/preset-classic",
{
"docs": {
"path": "../docs",
"sidebarPath": "/Users/diegoponce/Documents/projects/Bowler/website/sidebars.js"
}
},
{
"theme": {
"customCss": "/Users/diegoponce/Documents/projects/Bowler/website/src/css/custom.css"
}
}
]
]
};
Loading