लाइसेंस शामिल करना और README लिखना

Python पैकेज विकसित करना

James Fulton

Climate informatics researcher

मुझे लाइसेंस की ज़रूरत क्यों है?

  • दूसरों को आपका कोड उपयोग करने की अनुमति देने के लिए
Python पैकेज विकसित करना

ओपन सोर्स लाइसेंस

  • अधिक जानकारी यहाँ देखें
  • यूज़र्स को
    • आपका पैकेज इस्तेमाल करने की
    • आपका पैकेज संशोधित करने की
    • आपके पैकेज के संस्करण वितरित करने की
1 https://choosealicense.com
Python पैकेज विकसित करना

README क्या है?

  • आपके पैकेज का "फ्रंट पेज"
  • Github या PyPI पर दिखता है
Python पैकेज विकसित करना

README में क्या शामिल करें

README सेक्शन

  • Title
  • Description और Features
  • Installation
  • Usage examples
  • Contributing
  • License
Python पैकेज विकसित करना

README फॉर्मेट

Markdown (commonmark)

  • README.md फ़ाइल में होता है
  • सरल
  • इस कोर्स और असल दुनिया में उपयोग होता है
reStructuredText

  • README.rst फ़ाइल में होता है
  • अधिक जटिल
  • असल दुनिया में भी आम है
Python पैकेज विकसित करना

Commonmark

README.md की सामग्री














`

रेंडर होने पर यह ऐसा दिखता है

Python पैकेज विकसित करना

Commonmark

README.md की सामग्री

# mysklearn

mysklearn is a package for complete 
**linear regression** in Python.


You can find out more about this package 
on [DataCamp](https://datacamp.com)

रेंडर होने पर यह ऐसा दिखता है

mysklearn

mysklearn is a package for complete linear regression in python.

You can find out more about this package on DataCamp

Python पैकेज विकसित करना

Commonmark

README.md की सामग्री

# mysklearn

mysklearn is a package for complete 
**linear regression** in Python.


You can find out more about this package 
on [DataCamp](https://datacamp.com)


## Installation
You can install this package using

रेंडर होने पर यह ऐसा दिखता है

mysklearn

mysklearn is a package for complete linear regression in python.

You can find out more about this package on DataCamp

Installation

You can install this package using

Python पैकेज विकसित करना

Commonmark

README.md की सामग्री

# mysklearn
mysklearn is a package for complete 
**linear regression** in Python.

You can find out more about this package 
on [DataCamp](https://datacamp.com)

## Installation
You can install this package using

```
pip install mysklearn
```

रेंडर होने पर यह ऐसा दिखता है

mysklearn

mysklearn is a package for complete linear regression in python.

You can find out more about this package on DataCamp

Installation

You can install this package using

pip install mysklearn
Python पैकेज विकसित करना

इन फाइलों को अपने पैकेज में जोड़ना

सबपैकेज वाले पैकेज के लिए डायरेक्टरी ट्री

mysklearn/
|-- mysklearn
|   |-- __init__.py
|   |-- preprocessing
|   |   |-- ...
|   |-- regression
|   |   |-- ...
|   |-- utils.py
|-- setup.py
|-- requirements.txt
|-- LICENSE      <--- नई फाइलें
|-- README.md    <--- टॉप डायरेक्टरी में जोड़ा गया
Python पैकेज विकसित करना

MANIFEST.in

आपके पैकेज डिस्ट्रीब्यूशन में शामिल होने वाली अतिरिक्त फाइलों की सूची देता है.

Python पैकेज विकसित करना

MANIFEST.in

MANIFEST.in की सामग्री

include LICENSE
include README.md

mysklearn/
|-- mysklearn
|   |-- __init__.py
|   |-- preprocessing
|   |   |-- ...
|   |-- regression
|   |   |-- ...
|   |-- utils.py
|-- setup.py
|-- requirements.txt
|-- LICENSE
|-- README.md
|-- MANIFEST.in   <---
Python पैकेज विकसित करना

अभ्यास करते हैं!

Python पैकेज विकसित करना

Preparing Video For Download...