o2h


Nameo2h JSON
Version 2.0.3 PyPI version JSON
download
home_page
SummaryPublish obsidian to hexo github page
upload_time2023-12-13 13:47:43
maintainer
docs_urlNone
author
requires_python>=3.9
license
keywords feed reader tutorial
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # H2O2H

This repository is used to help Obsidian publish more conveniently.

## Installing

```bash
pip install o2h
```

## Getting Started

After o2h package is installed, the cli command obs2hexo is available. The help info is listed here.

```bash
obs2hexo -h

usage: obs2hexo [-h] [-o OUTPUT] [-c CATEGORY] [-p | --picgo | --no-picgo] filename

positional arguments:
  filename              get the obs markdown filename

options:
  -h, --help            show this help message and exit
  -o OUTPUT, --output OUTPUT
                        get output dir
  -c CATEGORY, --category CATEGORY
                        get category
  -p, --picgo, --no-picgo
                        use picgo
```

As the Github repository space is limited, so it is not recommanded to upload all the pictures  to the repository. So I provide an alternative option `-p` to upload pictures with [picgo](https://github.com/PicGo/PicGo-Core).

The default output directory is `/tmp/o2houtput`.

## Configuration

o2h cannot find the position of Obsidian Vault automatically, so it relies on the configuration file. A configuration file should be created in `$HOME/.config/o2h/config.json`

Here is an example of my config file:

```json
{
    "obsidian_target": [
        "$HOME/Documents/Work/Notes"
    ]
}
```

If there are multiple Obsidian Vault in you system, you can add them like this:

```json
{
  "obsidian_target": [
    "path_1",
    "path_2",
    ...,
    "path_n"
  ]
}
```

## Example

Here are some examples:

```bash
# translate a.md to standard markdown
# the category is "Skill"
# all the picture are copied to a new folder named 'a' in current directory
obs2hexo -o $PWD -c Skill a.md
# translate b.md to /tmp/o2houtput, all the picture are uploaded by picgo
obs2hexo -c Develop -p b.md
```

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "o2h",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "feed,reader,tutorial",
    "author": "",
    "author_email": "Chivier Humber <chivier.humber@outlook.com>",
    "download_url": "https://files.pythonhosted.org/packages/37/0c/b558bcf829387cd9456ffe93b8f018ee3a30d41b37734159a5afaef75ab5/o2h-2.0.3.tar.gz",
    "platform": null,
    "description": "# H2O2H\n\nThis repository is used to help Obsidian publish more conveniently.\n\n## Installing\n\n```bash\npip install o2h\n```\n\n## Getting Started\n\nAfter o2h package is installed, the cli command obs2hexo is available. The help info is listed here.\n\n```bash\nobs2hexo -h\n\nusage: obs2hexo [-h] [-o OUTPUT] [-c CATEGORY] [-p | --picgo | --no-picgo] filename\n\npositional arguments:\n  filename              get the obs markdown filename\n\noptions:\n  -h, --help            show this help message and exit\n  -o OUTPUT, --output OUTPUT\n                        get output dir\n  -c CATEGORY, --category CATEGORY\n                        get category\n  -p, --picgo, --no-picgo\n                        use picgo\n```\n\nAs the Github repository space is limited, so it is not recommanded to upload all the pictures  to the repository. So I provide an alternative option `-p` to upload pictures with [picgo](https://github.com/PicGo/PicGo-Core).\n\nThe default output directory is `/tmp/o2houtput`.\n\n## Configuration\n\no2h cannot find the position of Obsidian Vault automatically, so it relies on the configuration file. A configuration file should be created in `$HOME/.config/o2h/config.json`\n\nHere is an example of my config file:\n\n```json\n{\n    \"obsidian_target\": [\n        \"$HOME/Documents/Work/Notes\"\n    ]\n}\n```\n\nIf there are multiple Obsidian Vault in you system, you can add them like this:\n\n```json\n{\n  \"obsidian_target\": [\n    \"path_1\",\n    \"path_2\",\n    ...,\n    \"path_n\"\n  ]\n}\n```\n\n## Example\n\nHere are some examples:\n\n```bash\n# translate a.md to standard markdown\n# the category is \"Skill\"\n# all the picture are copied to a new folder named 'a' in current directory\nobs2hexo -o $PWD -c Skill a.md\n# translate b.md to /tmp/o2houtput, all the picture are uploaded by picgo\nobs2hexo -c Develop -p b.md\n```\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Publish obsidian to hexo github page",
    "version": "2.0.3",
    "project_urls": {
        "Homepage": "https://github.com/Chivier/H2O2H"
    },
    "split_keywords": [
        "feed",
        "reader",
        "tutorial"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "42dc1f1f8390f7da3189c12fb28a68a97a19b45a72e380000f410ba465e0918a",
                "md5": "960c851a4d5d98f88d7a9e281dbcd9c1",
                "sha256": "61df366a1279b6da5d11baead4fc2a73118287c34eb50dd521f0a21f6b80a4db"
            },
            "downloads": -1,
            "filename": "o2h-2.0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "960c851a4d5d98f88d7a9e281dbcd9c1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 5720,
            "upload_time": "2023-12-13T13:47:41",
            "upload_time_iso_8601": "2023-12-13T13:47:41.973482Z",
            "url": "https://files.pythonhosted.org/packages/42/dc/1f1f8390f7da3189c12fb28a68a97a19b45a72e380000f410ba465e0918a/o2h-2.0.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "370cb558bcf829387cd9456ffe93b8f018ee3a30d41b37734159a5afaef75ab5",
                "md5": "cae3fb34df6b13b43a2cf424c4fdd50b",
                "sha256": "e5b5d0862f0b9282b3a1bbeb0d5f6ca0b16492df829efb56570706ba19796829"
            },
            "downloads": -1,
            "filename": "o2h-2.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "cae3fb34df6b13b43a2cf424c4fdd50b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 5702,
            "upload_time": "2023-12-13T13:47:43",
            "upload_time_iso_8601": "2023-12-13T13:47:43.216095Z",
            "url": "https://files.pythonhosted.org/packages/37/0c/b558bcf829387cd9456ffe93b8f018ee3a30d41b37734159a5afaef75ab5/o2h-2.0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-13 13:47:43",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Chivier",
    "github_project": "H2O2H",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "o2h"
}
        
Elapsed time: 0.21830s