Metadata-Version: 2.1
Name: filemod
Version: 1.2
Summary: File operation lib
Home-page: https://github.com/kshitij1235/filemod
Author: kshitij jathar
Author-email: kshitijjathar7@gmail.com
License: MIT
Project-URL: Bug Tracker, https://github.com/kshitij1235/filemod/issues
Keywords: file
Platform: UNKNOWN
Classifier: Intended Audience :: Education
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
License-File: LICENSE

## File Mod

File mod is easy to perform file operations with the help of  good method names 
and less arguments to pass

### Bug fix 

1) unwanted lib included


### Installation and Usage

1. use `pip install file-mod`
2. Make sure that your `pip` version is updated `pip install --upgrade pip`. 
3. Select the correct package for your environment:
4. Import the package: ``import filemodpakage``

### Functions in the module 

1) This is a file reader method reads file content and returns it as string
`filemodpakage.reader(filename)`

2) This file writer method writes contents to the file 
`filemodpakage.writer(filename,content,method)`

3) This read_specific_line reads a specific line of the file and returns it as string 
`filemodpakage.read_specific_line(filename,line)`

4) This extract_numbers_from reads a numbers from the file and returns all the collection of numbers in a list
`filemodpakage.read_specific_line(filename,line)`

5) This extracts the number of lines `filemodpakage.extract_numbers_from(filename)`

6) This delete a specific word from a file `filemodpakage.remove_word(filename,word)`

6) This delete a specific line from a file `filemodpakage.delete_specific_line(filename,line)`


## Run Locally

Clone the project

```bash
  git clone https://github.com/kshitij1235/filemod/tree/main/dist
```

Install

```bash
  pip install file-mod
```
## List of Functions

| function name            | Description| args|
| ----------------- | ---|----------|
| Reader|Reads file| filename|    
| writer | writes content to file|filename,content,method|
| read_specific_line| read_specific_line |filename,line|
|extract_numbers_from|extracts number form file|filename
|extract_numbers_from|extracts number form file|filename
|remove_word|removes a specific word|filename,word
|number_of_line|Get the number of lines in a file |filename
|delete_specific_line(from 1 - n)|Delete a specific line |filename,line



## Usage/Examples

### read file

```javascript
import filemodpakage

filemodpakage.reader('demo_file.txt')
```

### write file

```javascript
import filemodpakage

filemodpakage.writer('demo_file.txt',content="new line ", method='w')
```


### read_specific_line

```javascript
import filemodpakage

filemodpakage.read_specific_line("demo_file.txt",1)
```

### extract_numbers_from a file 

```javascript
import filemodpakage

filemodpakage.extract_numbers_from("demo_file.txt")
```

### remove_word for a file 

```javascript
import filemodpakage

filemodpakage.remove_word("demo_file.txt","hello")
```

### number_of_line

```javascript
import filemodpakage

filemodpakage.number_of_line("demo_file.txt")
```

### delete_specific_line

```javascript
import filemodpakage

filemodpakage.delete_specific_line("demo_file.txt",1)
```

  
## Badges


[![MIT License](https://img.shields.io/apm/l/atomic-design-ui.svg?)](https://github.com/kshitij1235/filemod/blob/main/LICENSE)

  
## Authors

- [@kshitij1235](https://github.com/kshitij1235)

  


