filemod 2.1
File operation lib
License: MIT
Keywords: file

## 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)fixed write specific line 
2)much more faster now 

### 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 filemod``

### Functions in the module 

1) This is a file reader method reads file content and returns it as string
`filemod.reader(filename)`

2) This file writer method writes contents to the file 
`filemod.writer(filename,content,method)`

3) This read_specific_line reads a specific line of the file and returns it as string 
`filemod.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
`filemod.read_specific_line(filename,line)`

5) This extracts the number of lines `filemod.extract_numbers_from(filename)`

6) This delete a specific word from a file `filemod.remove_word(filename,word)`

7) This delete a specific line from a file `filemod.delete_specific_line(filename,line)`
8) This write a specific line from a file `filemod.write_specific_line(filename,line)`


## Run Locally

Clone the project

```bash
  git clone https://github.com/kshitij1235/filemod/tree/main/dist
```

Install

```bash
  pip install filemod
```
## 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|
|remove_word         |removes a specific word|filename,word|
|number_of_line      |Get the number of lines in a file |filename|
|delete_specific_line|Delete a specific line |filename,line|
|write_specific_line |write a specific line |filename,line,content|


## Usage/Examples

### read file

```javascript
import filemod

filemod.reader('demo_file.txt')
```

### write file

```javascript
import filemod

filemod.writer('demo_file.txt',content="new line ", method='w')
```


### read_specific_line

```javascript
import filemod

filemod.read_specific_line("demo_file.txt",1)
```

### extract_numbers_from a file 

```javascript
import filemod

filemod.extract_numbers_from("demo_file.txt")
```

### remove_word for a file 

```javascript
import filemod

filemod.remove_word("demo_file.txt","hello")
```

### number_of_line

```javascript
import filemod

filemod.number_of_line("demo_file.txt")
```

### delete_specific_line

```javascript
import filemod

filemod.delete_specific_line("demo_file.txt",1)
```

### write_specific_line

```javascript
import filemod
data="this is text"
filemod.write_specific_line("demo_file.txt",1,data)
```

  
## 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)