Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mamezou-tech/sbgraph
Fetch Scrapbox project data and visualize activities.
https://github.com/mamezou-tech/sbgraph
graph graphviz-dot scrapbox
Last synced: 30 days ago
JSON representation
Fetch Scrapbox project data and visualize activities.
- Host: GitHub
- URL: https://github.com/mamezou-tech/sbgraph
- Owner: mamezou-tech
- License: mit
- Created: 2020-02-25T03:25:38.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-06-12T00:15:24.000Z (6 months ago)
- Last Synced: 2024-06-21T19:52:01.339Z (6 months ago)
- Topics: graph, graphviz-dot, scrapbox
- Language: Go
- Size: 97.7 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sbgraph
[](https://goreportcard.com/report/github.com/mamezou-tech/sbgraph)
sbgraph is a CLI for fetching and visualizing data from [Scrapbox](https://scrapbox.io) project.
- Fetch page data (JSON format)
- Aggregate user activities (pages created, views of created page, etc.)
- Generate graph data (as Graphviz dot file)
## Installing
```
go get -u github.com/mamezou-tech/sbgraph
```
or
```
curl -LO https://github.com/mamezou-tech/sbgraph/releases/download//sbgraph--amd64.tar.gz
tar xvf sbgraph--amd64.tar.gz
sudo mv sbgraph /usr/local/bin
```
## Sub commands
### Initialize config & working directory
```
sbgraph init
```
Config file (.sbgraph.yaml) will be created in users home directory.
Data fetched via Scrapbox APIs will be stored in an existing working directory.
By default working directory will be set `$(pwd)/_work`
In config file working directory will be set to that path.
```yaml
workdir: path/to/workdir
```
If the working directory does not exist, it will be created.
Of cource, you can specify the directory every time you execute sub commands with global -d(--workdir) flag.
```
sbgraph fetch -d
```
### Set target project
```
sbgraph project -p
```
```yaml
currentproject: project-name
```
### Print configuration status
```
sbgraph status
```
Config file path and current settings will be printed.
### Fetch page data of the project
Fetch page data of the Scrapbox project via [Scrapbox APIs](https://scrapbox.io/help-jp/API).
- Page list data will be saved as JSON file at `/.json`.
- Each Page data will be saved as JSON file in `/`.
- The file name consists of the page ID.
```
sbgraph fetch
```
To fetch from a private project, you needs to set the cookie to environment variables.
```
export SB_COOKIE_ID=connect.sid
export SB_COOKIE_VALUE=your-fancy-cookie
```
### Aggregate user activites in the project
Parse page data and aggregate activities of the project per user.
- Pages created
- Pages contributed
- Views of created page
- Links of created page
```
sbgraph aggregate
```
CSV will be created at `/.csv`.
### Generate graph of the pages and users
Parse page data and generate graph of pages and users.
```
sbgraph graph
```
If you want to include user node to the graph, specify -i(--include) flag.
```
sbgraph graph -i=true
```
If you want to annonymize user name of user node, specify -a(--anonymize) flag.
```
sbgraph graph -i=true -a=true
```
You can reduce number of nodes in the graph by specifying page views as threshold value.
```
sbgraph graph -t 100
```
Graphviz dot file will be created at `/.dot`.
To generate graph data as JSON, specify -j(--json) flag.
```
sbgraph graph -j=true
```
If you want replace the output username to something else, create the `/_authors.json` file as follows. The `id` must match what actually exists.
```json
{
"authors": [
{
"id": "5b123abcdeefe345689seded",
"name": "Alice"
},
{
"id": "5d3435ddfdaab341234dedea",
"name": "Bob"
}
]
}
```
IF you want extract tags from links of the page, create the `/_tags.csv` file as follows. If the links or related page titles of the page match those words,they will be added as tag attributes.
```
word1,word2,word3
```
To generate graph image as SVG format, specify -m(--image) flag.
```
sbgraph graph -m=true
```
Graphviz needs to be installed. You can not specify layout engine.
### Visualize with Graphviz
You can generate SVG with graph sub command, but to specify more options such as layout engine, you can use dot command directly.
e.g.
```
dot .dot -Tsvg -Kfdp -Goverlap=prism -.svg
```