search

NatsuSolar / docstringFormatter

Format docstring to be able to entry in DeepL or GoogleTranslate.
Other
1 stars 0 forks source link

Record of History #1

Open NatsuSolar opened 1 year ago

NatsuSolar commented 1 year ago

Record of History

Record of This Project History will line here.

ABOUT REPOSITORY

Format docstring to be able to entry in DeepL or GoogleTranslate.

NEW RELEASE

It is undecided whether new version releases. Basically, when the authoer, I, feel to want to fix or add new function, it will be determined to get release a new version.

I wish each you customize this code in the way you think it is the best practice.

Thanks.

NatsuSolar commented 1 year ago

[Add] "LICENSE" and "README.md" get in.

Summary

  1. Contens of "README.md" is initialaized with "MIT LICENSE" Option of GitHub.
  2. Contens of "LICENSE" is written as a temporary one.

Commit 48e033a -- Initial commit

(Add) LICENSE (Add) README.md

Reference URL

None

★☆☆☆☆

docstringFormatter

LICENSE #README.md #Initial commit

NatsuSolar commented 1 year ago

[Modify] Edit of "LICENSE" and "README.md"

Summary

  1. Initial contents of "LICENSE" changes to the short version one.
    • The category of license remains "MIT LICENSE"
    • Change License clause to refer on Web source.
  2. The temporary contens of "README.md" changes to regular version one.

Commit b1afca8 -- Initial commit

(Modify) LICENSE (Modify) README.md

Reference URL

  1. ソースコードのライセンスの書き方

★★★★★

docstringFormatter

README.md #LICENSE #MIT LICENSE

NatsuSolar commented 1 year ago

[Add] Upload ALL Files for Package

Summary

  1. Upload ALL Files for Package
    • Some files(e.g. README.md) are unfinished.

Commit 002aa6a -- [Add] Upload ALL Files for Package

Tree graph of package

root
├── (Add) docstringFormatter
│   ├── (Add) docstringFormatter/__init__.py
│   └── (Add) docstringFormatter/docstringFormatter.py
├── (Add) SampleTextfile
│   ├── (Add) SampleTextfile/TextOutput_DefaultSetting_at_main().txt
│   └── (Add) SampleTextfile/TextOutput_OriginalSentenceSetting_at_main().txt
├── (Add) TEST
│   └── (Add) TEST/__init__.py
├── (Add) CHANGELOG.md
├── (Add) LICENSE
├── (Add) MANIFEST.in
├── (Add) README.md
├── (Add) requirements.txt
└── (Add) TEST-requirements.txt

Reference URL

  1. PyPIパッケージ定義ファイル作成方法 - init.py setup.py MANIFEST.in の書き方
  2. CHANGELOG の書き方
  3. Markdown記法一覧
  4. Python初心者が、PyPIに自作のパッケージを登録しようとしてハマったこと　２０１７年２月版

★★★★★

docstringFormatter

translate #DeepL #GoogleTranslate

delete #remove #indent #newline #tab #space

replace() #str #escape sequence #\n #\t

tree graph

NatsuSolar commented 1 year ago

[Add] Reform dir tree and Correct escape sequence of docstring

Summary

  1. Making dir "src" and dir docstringFormatter relocate under that.
    • To not "TEST" dir allow being packaged.
  2. (L23-24)Correct escape sequence of docstring.

-- [Add] Reform dir tree and Correct escape sequence of docstring

root
├── (Add) src
│   └──(Add) src\docstringFormatter
│         └── (Add) src\docstringFormatter\docstringFormatter.py
│         └── (Add) src\docstringFormatter\__init__.py
│
├── ( ___ ) SampleTextfile
│   ├── ( ___ ) SampleTextfile\TextOutput_DefaultSetting_at_main().txt
│   └── ( ___ ) SampleTextfile\TextOutput_OriginalSentenceSetting_at_main().txt
├──( ___ ) TEST
│   └── ( ___ ) TEST\__init__.py
├── (Add) CHANGELOG.md
├── ( ___ ) LICENSE
├── ( ___ ) MANIFEST.in
├── ( ___ ) README.md
├── ( ___ ) requirements.txt
└── ( ___ ) TEST-requirements.txt

Reference URL

  1. Packaging Python Projects
  2. 2022年版pyproject.tomlを使ったPythonパッケージの作り方

★★★☆☆

docstringFormatter

tree #src #src-layout

str #escape sequence #\n #\t

NatsuSolar commented 1 year ago

[Modify] Correct grammatical misstake and Add discription of "Usage"

Summary

  1. (L.111) Correct grammatical misstake
    • showed ---> shown
  2. (Other) Add discription of "Usage" etc.

    Commit fc05ff1 -- [Modify] Correct grammatical misstake and Add discription of "Usage"

(Modify) README.md

Reference URL

None

★☆☆☆☆

README.md #Usage

NatsuSolar commented 1 year ago

[Remove] Make GitHub stop tracing the some files by introcusing ".gitignore"

Summary

  1. Introducing ".gitignore" file
  2. Can not have found ".idea" dir in the project tree of PayCharm.

    Commit b956ab7 -- [Remove] Make GitHub stop tracing the some files by introcusing ".gitignore"

(Remove) build\lib

Reference URL

  1. gitで、追跡対象ファイルの外す（追跡をやめる）方法。

★☆☆☆☆

.gitignore

NatsuSolar commented 1 year ago

[Remove] ".idea" get in ".gitignore"

Summary

  1. Add ".idea" in ignore list.
    • Directly see File explorer
    • cmd command: 
  git rm --cached .idea\*

Commit ff04a1d -- [Remove] ".idea" get in ".gitignore"

(Remove) .idea*

Reference URL

None

★★☆☆☆

.gitignore #cmd #command #git rm --cached .idea*

NatsuSolar commented 1 year ago

[Modify] Correct 2 files

Summary

  1. (L.4,5) src/docstringFormatter/init.py

    • Delete: version
    • Modify: license: 'MIT' ---> 'The MIT License'

  2. (Other) pyproject.toml

    • Correct some sentence
    • To finsh build at the point of GitHub releasing(Reference: Reference URL >> 3.)

      Commit 1266066 -- [Modify] Correct 2 files

(Modify) src/docstringFormatter/init.py (Modify) pyproject.toml

Reference URL

  1. Configuring setuptools using_Setuptools-specific configuration

  2. PyPIパッケージのリリースもバージョニングもGitHub単独で完結させる

  3. 2022年版pyproject.tomlを使ったPythonパッケージの作り方

★★★★☆

pyproject.toml #Repository secrets #API token #setuptools_scm #publish-to-pypi.yml

_version.py

NatsuSolar commented 1 year ago

[Modify] Correct grammatical misstake and Add discription of "Usage"

[insert] <,<,<,< , [insert], < ,...

Summary

  1. (L.111) Correct grammatical misstake
    • showed ---> shown
  2. (Other) Add discription of "Usage" etc.

    Commit fc05ff1 -- [Modify] Correct grammatical misstake and Add discription of "Usage"

(Modify) README.md

Reference URL

None

★☆☆☆☆

README.md #Usage

NatsuSolar commented 1 year ago

[Modify] Correct 5 files

Summary

  1. Correct 5 files
    • src/docstringFormatter/init.py
    • 🐱
    • CHANGELOG.md 　- _version.py gets in dir Tree
    • LICENSE
    • Change format
    • MANIFEST.in
    • Add [build, dist, TEST] to "pure"
    • README.md
    • Add few newlines to bottom

Commit 744e4fa -- [Modify] Correct 5 files

(Modify) src/docstringFormatter/init.py (Modify) CHANGELOG.md (Modify) pyproject.toml (Modify) MANIFEST.in (Modify) README.md

Reference URL

None

★☆☆☆☆

small fix

NatsuSolar commented 1 year ago

[Modify] Correct 5 files

Summary

  1. Correct 5 files
    • src/docstringFormatter/init.py
    • 🐱
    • CHANGELOG.md 　- _version.py gets in dir Tree
    • LICENSE
    • Change format
    • MANIFEST.in
    • Add [build, dist, TEST] to "pure"
    • README.md
    • Add few newlines to bottom
  2. I don't get why this commit occurs.

    Commit 8336a8b -- [Modify] Correct 5 files

(Modify) src/docstringFormatter/init.py (Modify) CHANGELOG.md (Modify) pyproject.toml (Modify) MANIFEST.in (Modify) README.md

Reference URL

None

★☆☆☆☆

small fix #enigma

NatsuSolar commented 1 year ago

[Modify] Make build possible with "tool" sections

Summary

  1. Main change points
    • (L8) version = '1.0.0.2' ---- add
    • (L35) "License :: OSI Approved :: MIT License"
    • (L53) package-dir = {"" = "src"} ---> package-dir = {"" = "."}

Commit 4a9eb9c -- [Modify] Make build possible with "tool" sections

(Modify) pyproject.toml

Reference URL

None

★★★★☆

package-dir #pyproject.toml #License #version #tool

NatsuSolar commented 1 year ago

[Merge] Merge remote-tracking branch 'origin/main'

Summary

  1. I don't get why this branch comes out of.

    Commit 29d4946 -- [Merge] Merge remote-tracking branch 'origin/main'

(Merge) Merge remote-tracking branch 'origin/main'

(Merge) 2 parents 4a9eb9c + 744e4fa

Reference URL

None

★★★☆☆

merge #v1.0.0

NatsuSolar commented 1 year ago

[Add] "_version.py"

Summary

  1. "_version.py" get in dir src/docstringFormatter

Commit e5e8579 -- [Add] "_version.py"

(Add) src/docstringFormatter/_version.py

Reference URL

None

★★★☆☆

_version.py #version

NatsuSolar commented 1 year ago

[Modify] delete the key "version" in [project] section

Summary

  1. (L8) version = "1.0.0.2"
    • To realize auto build function on GitHub
    • I think this line interrupts auto build

      Commit 55b36f0 -- [Modify] delete the key "version" in [project] section

(Add) pyproject.toml

Reference URL

None

★★★☆☆

pyproject.toml #version

NatsuSolar commented 1 year ago

[Modify] get "version" in [project] section

Summary

  1. (L8) version = "1.0.0.2"
    • To realize auto build function on GitHub

      Commit 2e30f44 -- [Modify] get "version" in [project] section

(Add) pyproject.toml

Reference URL

None

★★☆☆☆

pyproject.toml #version

NatsuSolar commented 1 year ago

[Modify] get "version" in [project] section

Summary

  1. (L8) version = "1.0.0.2" ---> version = "1.0.0"

(Add) pyproject.toml

Reference URL

  1. PyPIへの登録にユーザー名とパスワードを使うのはやめよう。APIトークンを使おう
  2. Python のプロジェクトをパッケージングする
  3. PEP 440 (Python のバージョン・スキーマ) 概説

★★★★★

pyproject.toml #version #v1.0.0 #release #Initial release

PyPI