Skip to content

Commit

Permalink
Commit for versions 2.2.0.
Browse files Browse the repository at this point in the history
- Added Variable bin sizing via Bayesian Boxing (feature request [#216])
- PyCharm integration, console attempts to detect file type.
- Fixed bug [#215].
- Updated the `missingno` package to 0.4.2, fixing the font size in the `bar` diagram.
- Various optimizations
  • Loading branch information
sbrugman committed Jul 17, 2019
1 parent 2658bfa commit a848267
Show file tree
Hide file tree
Showing 40 changed files with 1,088 additions and 388 deletions.
8 changes: 7 additions & 1 deletion Makefile
@@ -1,4 +1,10 @@
docs:
pdoc3 --html --force --output-dir docs pandas_profiling
mv docs/pandas_profiling/* docs
rmdir docs/pandas_profiling
rmdir docs/pandas_profiling

install:
pip install -e .

lint:
black .
37 changes: 37 additions & 0 deletions README.md
Expand Up @@ -140,6 +140,43 @@ If you would like to be a industry partner or sponsor, please [drop us a line](m

Read more on getting involved in the [Contribution Guide](https://github.com/pandas-profiling/pandas-profiling/blob/master/CONTRIBUTING.md).


## Editor integration
### PyCharm integration
1. Install `pandas-profiling` via the instructions above
2. Locate your `pandas-profiling` executable.

On macOS / Linux / BSD:

```console
$ which pandas_profiling
(example) /usr/local/bin/pandas_profiling
```

On Windows:

```console
$ where pandas_profiling
(example) C:\ProgramData\Anaconda3\Scripts\pandas_profiling.exe
```

2. In Pycharm, go to _Settings_ (or _Preferences_ on macOS) > _Tools_ > _External tools_
3. Click the _+_ icon to add a new external tool
4. Insert the following values
- Name: Pandas Profiling
- Program: *__The location obtained in step 2__*
- Arguments: "$FilePath$" "$FileDir$/$FileNameWithoutAllExtensions$_report.html"
- Working Directory: $ProjectFileDir$

![PyCharm Integration](http://pandas-profiling.github.io/pandas-profiling/docs/assets/pycharm-integration.png)

To use the PyCharm Integration, right click on any dataset file:
_External Tools_ > _Pandas Profiling_.

### Other integrations

Other editor integrations may be contributed via pull requests.

## Dependencies

You need [Python 3](https://python3statement.org/) to run this package. Other dependencies can be found in the requirements files:
Expand Down
Binary file added docs/assets/pycharm-integration.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 14 additions & 4 deletions docs/controller/console.html
Expand Up @@ -32,6 +32,8 @@ <h1 class="title">Module <code>pandas_profiling.controller.console</code></h1>
from pandas_profiling.config import config
import argparse

from pandas_profiling.utils.dataframe import read_pandas


def parse_args(args: list or None = None) -&gt; argparse.Namespace:
&#34;&#34;&#34;Parse the command line arguments for the `pandas_profiling` binary.
Expand Down Expand Up @@ -72,7 +74,11 @@ <h1 class="title">Module <code>pandas_profiling.controller.console</code></h1>
default=&#34;Pandas Profiling Report&#34;,
help=&#34;Title for the report&#34;,
)
parser.add_argument(&#34;input_file&#34;, type=str, help=&#34;CSV file to profile&#34;)
parser.add_argument(
&#34;input_file&#34;,
type=Path,
help=&#34;CSV file (or other file type supported by pandas) to profile&#34;,
)
parser.add_argument(&#34;output_file&#34;, type=Path, help=&#34;Output report file&#34;)

return parser.parse_args(args)
Expand All @@ -90,7 +96,7 @@ <h1 class="title">Module <code>pandas_profiling.controller.console</code></h1>
config.set_args(args, dots=True)

# read the DataFrame
df = pd.read_csv(str(args.input_file))
df = read_pandas(args.input_file)

# Generate the profiling report
p = df.profile_report()
Expand Down Expand Up @@ -134,7 +140,7 @@ <h2 id="args">Args</h2>
config.set_args(args, dots=True)

# read the DataFrame
df = pd.read_csv(str(args.input_file))
df = read_pandas(args.input_file)

# Generate the profiling report
p = df.profile_report()
Expand Down Expand Up @@ -200,7 +206,11 @@ <h2 id="returns">Returns</h2>
default=&#34;Pandas Profiling Report&#34;,
help=&#34;Title for the report&#34;,
)
parser.add_argument(&#34;input_file&#34;, type=str, help=&#34;CSV file to profile&#34;)
parser.add_argument(
&#34;input_file&#34;,
type=Path,
help=&#34;CSV file (or other file type supported by pandas) to profile&#34;,
)
parser.add_argument(&#34;output_file&#34;, type=Path, help=&#34;Output report file&#34;)

return parser.parse_args(args)</code></pre>
Expand Down
37 changes: 37 additions & 0 deletions docs/index.html
Expand Up @@ -127,6 +127,38 @@ <h2 id="how-to-contribute">How to contribute</h2>
There are several ways of contributing and helping our thousands of users.
If you would like to be a industry partner or sponsor, please <a href="mailto:pandasprofiling@gmail.com">drop us a line</a>.</p>
<p>Read more on getting involved in the <a href="https://github.com/pandas-profiling/pandas-profiling/blob/master/CONTRIBUTING.md">Contribution Guide</a>.</p>
<h2 id="editor-integration">Editor integration</h2>
<h3 id="pycharm-integration">PyCharm integration</h3>
<ol>
<li>Install <code>pandas-profiling</code> via the instructions above</li>
<li>
<p>Locate your <code>pandas-profiling</code> executable.</p>
<p>On macOS / Linux / BSD:</p>
<p><code>console
$ which pandas_profiling
(example) /usr/local/bin/pandas_profiling</code></p>
<p>On Windows:</p>
<p><code>console
$ where pandas_profiling
(example) C:\ProgramData\Anaconda3\Scripts\pandas_profiling.exe</code></p>
</li>
<li>
<p>In Pycharm, go to <em>Settings</em> (or <em>Preferences</em> on macOS) &gt; <em>Tools</em> &gt; <em>External tools</em></p>
</li>
<li>Click the <em>+</em> icon to add a new external tool</li>
<li>Insert the following values<ul>
<li>Name: Pandas Profiling</li>
<li>Program: <em><strong>The location obtained in step 2</strong></em></li>
<li>Arguments: "$FilePath$" "$FileDir$/$FileNameWithoutAllExtensions$_report.html"</li>
<li>Working Directory: $ProjectFileDir$</li>
</ul>
</li>
</ol>
<p><img alt="PyCharm Integration" src="http://pandas-profiling.github.io/pandas-profiling/docs/assets/pycharm-integration.png"></p>
<p>To use the PyCharm Integration, right click on any dataset file:
<em>External Tools</em> &gt; <em>Pandas Profiling</em>.</p>
<h3 id="other-integrations">Other integrations</h3>
<p>Other editor integrations may be contributed via pull requests.</p>
<h2 id="dependencies">Dependencies</h2>
<p>You need <a href="https://python3statement.org/">Python 3</a> to run this package. Other dependencies can be found in the requirements files:</p>
<table>
Expand Down Expand Up @@ -699,6 +731,11 @@ <h1>Index</h1>
</ul>
</li>
<li><a href="#how-to-contribute">How to contribute</a></li>
<li><a href="#editor-integration">Editor integration</a><ul>
<li><a href="#pycharm-integration">PyCharm integration</a></li>
<li><a href="#other-integrations">Other integrations</a></li>
</ul>
</li>
<li><a href="#dependencies">Dependencies</a></li>
</ul>
</li>
Expand Down

0 comments on commit a848267

Please sign in to comment.