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 documentation for PyCharm Plugin #750

Merged

Conversation

koxudaxi
Copy link
Sponsor Contributor

@koxudaxi koxudaxi commented Aug 16, 2019

Change Summary

The PR adds documentation for PyCharm Plugin.

Related issue number

#650

Checklist

  • Unit tests for the changes exist
  • Tests pass on CI and coverage remains at 100%
  • Documentation reflects the changes where applicable
  • changes/<pull request or issue id>-<github username>.rst file added describing change
    (see changes/README.md for details)

@codecov
Copy link

@codecov codecov bot commented Aug 16, 2019

Codecov Report

Merging #750 into master will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff          @@
##           master   #750   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files          15     15           
  Lines        2725   2723    -2     
  Branches      536    536           
=====================================
- Hits         2725   2723    -2

@dmontagu
Copy link
Collaborator

@dmontagu dmontagu commented Aug 16, 2019

@koxudaxi Let me offer the following wordsmithing suggestions:

**plays nicely with your IDE/linter/brain**
    because *pydantic* data structures are just instances of classes you define;
    :ref:`auto-completion <pycharm_plugin>`, linting, :ref:`mypy <usage_mypy>` and your intuition
    should all work properly with your validated data.

(It seems awkward to me to call out PyCharm specifically this early in the docs, but I think it's okay to make a reference (I just put the link on "auto-completion"). I'd defer to @samuelcolvin though.)

.. _pycharm_plugin:

PyCharm Plugin
--------------

While pydantic will work well with any IDE out of the box, a PyCharm plugin
offering improved pydantic integration is available on the JetBrains Plugins Repository.
You can install the plugin for free from the plugin marketplace
(PyCharm's Preferences -> Plugin -> Marketplace).

The plugin currently supports the following features:

* For ``pydantic.BaseModel.__init__``:

     * Inspection
     * Autocompletion
     * Type-checking

* For fields of ``pydantic.BaseModel``:

    * Refactor-renaming fields updates ``__init__`` calls, and affects sub- and super-classes
    * Refactor-renaming ``__init__`` keyword arguments updates field names, and affects sub- and super-classes

More information can be found on the
`official plugin page <https://plugins.jetbrains.com/plugin/12861-pydantic>`_
and `Github repository <https://github.com/koxudaxi/pydantic-pycharm-plugin>`_.

Feel free to reject if you dislike/disagree with any of the changes.

@koxudaxi
Copy link
Sponsor Contributor Author

@koxudaxi koxudaxi commented Aug 16, 2019

@dmontagu
Thank you reviewing my document.
I feel great about your sentence.
I have merged only the section of PyCharm Plugin.

@samuelcolvin
if you want to change the introduction section which is written dmontagu. (**plays nicely with you...) , then I merge one too.

Copy link
Owner

@samuelcolvin samuelcolvin left a comment

otherwise looks great.

docs/index.rst Outdated Show resolved Hide resolved
docs/index.rst Outdated Show resolved Hide resolved
docs/index.rst Outdated Show resolved Hide resolved
Co-Authored-By: Samuel Colvin <samcolvin@gmail.com>
@koxudaxi
Copy link
Sponsor Contributor Author

@koxudaxi koxudaxi commented Aug 16, 2019

@samuelcolvin
Thank you. I have committed!!

@samuelcolvin samuelcolvin merged commit 08c6af8 into samuelcolvin:master Aug 16, 2019
10 checks passed
@samuelcolvin
Copy link
Owner

@samuelcolvin samuelcolvin commented Aug 16, 2019

thank you very much.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants